A few query parameters change what a read returns or how you address a resource.

🚧

PENDING-PUBLISH

The boarding API Reference is pending publication; the ref: targets on this page are placeholders. Replace each with the real boarding-spec operationId once the boarding reference ships.

?expand=true

By default a business GET returns the business with its children addressable by uri. Add ?expand=true to return the full nested business profile in one request. Make a GET request to /v1/businesses/{businessId} with ?expand=true.

curl "https://sandbox-api.prioritycommerce.com/v1/businesses/{businessId}?expand=true" \
  -H "x-api-key: <your-key>"

?externalId=

Attach your own externalId to a resource, then resolve it later without storing PCE's id. Use ?externalId= to find a business by your identifier, so you never store PCE's id.

curl "https://sandbox-api.prioritycommerce.com/v1/businesses?externalId=acme-merchant-001" \
  -H "x-api-key: <your-key>"

Paging

List endpoints accept a limit to control page size. limit must be an integer between 1 and 250; a value outside that range returns 422. See Pagination.

🚧

PENDING-PUBLISH

The exact casing and behavior of ?expand=true and ?externalId= (GET-by-externalId versus a list filter) are being reconciled against the boarding spec/Postman. Confirm both, and the full paging parameter set, before publish.

See also

• Pagination: how list results are paged
• Idempotent Requests: externalId as the idempotency key
• Getting Started: creating and updating entities