Developer APIResourcesAPI platform

List access profiles

List all access profiles belonging to an API client. If you don`t provide an API client ID, the resource lists all access profiles for all API clients. <Warning title="DEPRECATION NOTICE"> This endpoint is planned for deprecation on December 1, 2025. Transition to the [List API keys](/workato-api/resources/api-platform/list-api-keys-v-2) endpoint before this date to ensure uninterrupted service.</Warning>

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Choose the page of access profiles to return. The starting page is 1. Defaults to 1.

per_pageintegerOptional

Number of access profiles returned in a single page. Defaults to 100. Max is 100.

api_client_idintegerOptional
Provide an API client ID to retrieve access profiles belonging to a specific API client.

Response

Success reply
idinteger or null
The ID of the access profile.
namestring or null
The name of the access profile.
api_client_idinteger or null
The ID of the API client to which this access profile belongs.
api_collection_idslist of any or null
The IDs of the API collections that are accessible by this access profile.
activeboolean or null
Indicates whether the access profile is disabled or enabled.
auth_typestring or null
The authentication method used in the access profile. Possible values are token, jwt, oauth2, and oidc.
created_atstring or null
Timestamp in ISO 8601 format when the API collection was created.
updated_atstring or null
Timestamp in ISO 8601 format when the API collection was last updated.

Errors