v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
accountUserProfiles

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

get/userprofiles/{+profileId}/accountUserProfiles

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

activeboolean

Select only active user profiles.

idsstring[]

Select only user profiles with these IDs.

maxResultsinteger

Maximum number of results to return.

pageTokenstring

Value of the nextPageToken from the previous result page.

searchStringstring

Allows searching for objects by name, ID or email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

subaccountIdstring

Select only user profiles with the specified subaccount ID.

userRoleIdstring

Select only user profiles with the specified user role ID.

Response

Successful response