API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/me/preferences
ark.get_user_preferences
Returns notification and sound preferences for the connected user, falling back to ARK defaults when no preferences row exists.
- Availability
- Expanded preview
- Scopes
notifications:read- ARK permissions
- None
- Team visibility
- Not entity-scoped
- Idempotency-Key
- Not required
- Approval
- No MCP approval on REST API-token calls
- Rate limit
- API credential and organization budgets
Parameters
None.
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/me/preferences' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Connected-user preferences
objectstringrequiredone of: api_response
okbooleanrequiredone of: true
api_versionstringrequiredone of: 2026-05-31
request_idstringrequireddataobjectrequireddata.userIdstringrequiredformat: uuid
data.notificationsEnabledbooleanrequireddata.soundNewBidbooleanrequireddata.soundQuoteAcceptedbooleanrequireddata.soundAwardSuccessbooleanrequireddata.volumenumberrequiredmin: 0; max: 1
data.createdAtstring | nullrequiredformat: date-time
data.modifiedAtstring | nullrequiredformat: date-time
data.modifiedBystring | nullrequiredformat: uuid
Errors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied