API reference

Browse the API catalog

1. Go to API Reference in the developer portal.
2. Use the version dropdown on an API card to select the version you need.
3. Click the card to open its documentation.

When in End of Support, each API card displays a status chip indicating the End of Life (EOL) date. For more information, see API lifecycle.

Use interactive documentation

On an API reference page, you can:

• Browse endpoints in the sidebar.
• View request and response schemas and examples.
• Test the endpoint and send live requests directly from the browser. You need to generate a bearer token to use this feature. For more information, see Generate a bearer token.
• View code snippets in multiple languages.
• Use MCP-enabled APIs directly from an MCP client.

Use with Postman

Download a Postman collection

1. Go to the API reference for the API.
2. Click the Postman icon in the bottom-right corner.
3. A .json collection file downloads automatically.

Import into Postman

1. Open Postman and click Import.
2. Select the downloaded .json file.

The collection includes all endpoints, parameters, and request bodies, organized into folders by resource.

Authenticate the collection

The collection uses an {{access_token}} variable for bearer token authentication. To configure it:

1. Generate a bearer token.
2. In Postman, open Collection Variables.
3. Set the access_token value to your generated token.

All requests in the collection automatically include Authorization: Bearer {{access_token}}.

Generate a bearer token from the API reference

Tokens expire after 1 hour.

Signed in users (recommended)

Use this method if you are signed in and have a registered application with an active subscription to the API.

1. Expand an action and select an endpoint.
2. Click the Key icon in the bottom-right corner of the screen to generate the token.
3. Select your application from the dropdown and click Generate Token.
4. Click Copy Token and close the dialog.
5. Paste the token into the Token field in the action screen, fill in any required parameters, and click Send API Request.

With client credentials

Use this method for CI/CD pipelines, service accounts, or any context where you have a client_id and client_secret but are not signing in through the portal.

1. Open any API documentation page.
2. Click the Key icon in the bottom-right corner.
3. Switch to the Manual tab.
4. Enter your client_id and client_secret.
5. Optionally, enter scopes.
6. Click Generate Token.
7. Copy the returned token.

You can request only scopes your subscription grants. If the portal rejects a scope, verify that your subscription includes the required account and profile access. For details on scope format and components, see Scopes.

Token details

Troubleshoot common errors