List location external IDs

Request

Retrieve the foreign-system IDs for a location: the location-level mappings (GoHighLevel location ID and MX Merchant merchant ID) plus every patient-scoped GHL/MX Merchant ID anchored to this location (each with its patientId). Location-level rows have a null patientId. Filter by system / idType / externalId; externalId enables reverse lookup (e.g. MX Merchant customerId -> patient). Keyset-paginated.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query

systemstring

Filter by system

Enum:"GHL""MX_MERCHANT"

idTypestring

Filter by external ID type

Enum:"CONTACT_ID""OPPORTUNITY_ID""LOCATION_ID""CUSTOMER_ID""MERCHANT_ID"

externalIdstring, [ 0 .. 255 ] characters

Filter by external ID value (exact match). Enables reverse lookup.

cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20

Example:limit=20

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/external-id?system=GHL&idType=CONTACT_ID&externalId=string&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

External IDs retrieved successfully

Bodyapplication/json

externalIdsArray of objects(ExternalIdDTO)

List of external IDs in this page

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Response

{
  "externalIds": [
    { … }
  ],
  "nextCursor": "string"
}