Skip to navigation

List locations

Returns the locations visible to your key. Pass organization_ref to scope the list to a single registry. Each location carries its pay (or null) and its standing warnings, including the no-pay warning for a location with no pay rate.

Authentication

AuthorizationBearer

Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Query parameters

organization_refstringOptional
Limit results to one registry.

Response headers

X-Request-IdstringOptional

The ID of this request. On an error it equals request_id in the body. If you sent an X-Request-Id, it is your value, returned unchanged. Log it, and quote it when contacting CONFIRM support.

Response

Locations.
datalist of objectsOptional

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error