List locations | CONFIRM Docs

Returns the locations visible to your key. Pass organization_ref to scope the list to a single registry.

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.

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

Locations.

datalist of objectsOptional

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

1	{
2	"data": [
3	{
4	"location_id": "d4f1a2b3-9c8e-4f7a-8b2d-1e3f5a6c7d89",
5	"external_ref": "cl_loc_88213",
6	"title": "Certified Nursing Assistant — Clearwater",
7	"status": "active",
8	"organization_ref": "cl_biz_4471",
9	"geocoded": true,
10	"address": "1234 Gulf Breeze Pkwy, Clearwater, FL 33755",
11	"created": true,
12	"warnings": []
13	}
14	]
15	}

$	curl https://api.confirm.global/partner/v1/locations \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"