Getting Started

PCS's Partner APIs are four REST domains -- Authorization, Entities, Dispatching, and Opportunity -- that all share the same OAuth2 client-credentials authentication. There's also an MCP (Model Context Protocol) server that exposes Entities, Dispatching, and Opportunity as tools for AI agents, using this same access token. Pick whichever fits your integration.

1. Get API credentials

[PLACEHOLDER — needs real content from someone with product knowledge of this process: how a partner actually requests and receives a client_id/client_secret pair (who to contact, whether there's a formal approval step, expected turnaround time).]

2. Get a Bearer token

Exchange your client ID and secret for an access token using the OAuth2 client-credentials grant. This is the same token used for every domain below, and for the MCP server.

curl -X POST \
  https://dev-openapi-apim.azure-api.net/public/authorization/v1/tokens/oauth \
  --data-urlencode grant_type=client_credentials \
  --data-urlencode client_id=<your-client-id> \
  --data-urlencode client_secret=<your-client-secret>

{"access_token": "eyJ...", "expires_in": 3600}

No scope field is used -- your credentials alone determine what you can access. Tokens expire (see expires_in); request a new one when yours does.

3. Make your first API call

Send the access token as a Bearer token on every request. For example, list your offices from the Entities API:

curl -X POST https://dev-openapi-apim.azure-api.net/public/entities/v2/offices/list \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"pageNumber": 1, "pageSize": 10}'

{"totalCount": 19, "result": [ { "...": "..." } ]}

Every domain follows the same pattern: paginated list operations are POST with a pageNumber/pageSize body; single-record lookups are GET by id.

4. Explore further

Browse the API Reference in the sidebar for endpoint-level details on Authentication, Entities, Dispatch, and Opportunity, or use the Try it out console on any operation to make a real call from your browser. If you're building an AI agent, see the MCP page instead -- it exposes the Entities, Dispatching, and Opportunity operations as tools over the Model Context Protocol, using this same Bearer token.