Skip to navigation
API ReferenceAccounts

Retrieve accounts for the authenticated user

Returns a paginated list of Ottimate accounts that the authenticated user has access to, based on partner associations linked to the OAuth client credentials.

Authentication

AuthorizationBearer
OAuth2 authentication flows. Auth server URLs will vary by environment

Headers

X-Api-KeystringRequired
API key for authentication
X-API-VersionstringOptional

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Query parameters

searchstringOptional
Search term to filter accounts by name
limitintegerOptionalDefaults to 50
Number of items per page
pageintegerOptionalDefaults to 1
Page number for pagination

Response

Successful response with paginated account list
versionstringOptional

The API version that rendered this response. Reflects the X-API-Version request header, falling back to 1.0.0 when the header is absent or names an unsupported version.

countintegerOptional
pageintegerOptional
limitintegerOptional
resultslist of objectsOptional

Errors

403
Forbidden Error
404
Not Found Error