v1Resources/Approvals/getList task owners

List task owners

List candidate task owners within the token creator’s current workspace and client access. This list does not grant access to a private project or guarantee eligibility for a particular task. Assignment rechecks the task audience; assigning or mentioning someone never shares private work.

get/api/v1/work-management/owners
approvals:read
Query parameters
clientIdstringoptional
Limit the list to one client. With a key that can reach all clients, this accepts the client's id, public id or slug, and a client the key's creator can't access returns 404. With a key limited to specific clients, pass the client's id; any other value, or a client outside the key's access, returns 403.
Response
okbooleanoptional
Always true on a successful response.
clientIdstringoptional
The client's id when you passed clientId, otherwise null.
ownersarray of objectoptional
People who can own a task: teammates first, then client users.
idstringoptional
The person's id. Pass it as ownerId when you create a task, or as userId when you set an owner.
namestringoptional
The person's display name.
typestring (user | client_user)optional
user for an agency teammate, client_user for a person from a client. Send the same value as ownerType.
clientIdstringoptional
The client this client user belongs to. Only on client users.
emailstringoptional
The client user's email address, or null. Only on client users.
Errors
401Missing, invalid, expired, or revoked API key.
403Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
404Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
429Too many requests. Retry after the number of seconds in the Retry-After header.
500The request couldn't be completed because of a problem on our side.
get/api/v1/work-management/owners
Your API key
clientId
{}

New to the Synup API?