v1

latestSwagger 2.02026-07-134146194.6 MB

Authorizations

Returns the authorizations for which the specified user is the agent user.

Returns the user authorizations for which the user specified by userId is the agent user.

If the calling user is an account administrator, the full results will be returned. Otherwise, only authorizations for which the calling user is the principal user will be returned.

get/v2.1/accounts/{accountId}/users/{userId}/authorizations/agent

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

userIdstring required

The user who is acting as the agent.

Query parameters

active_onlystring

When true, only active users are returned. The default value is false.

countstring

The maximum number of results to return.

email_substringstring

Filters returned user records by full email address or a substring of email address.

include_closed_usersstring

When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.

permissionsstring

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

task_sourcestring

task_typestring

user_name_substringstring

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Response

Successful response.