Skip to content

List patient external IDs

Request

Retrieve the foreign-system IDs (GoHighLevel contact/opportunity, MX Merchant customer) Lobbie maintains for the patient. Each row includes the Lobbie locationId it belongs to. Filter by system / idType / externalId; keyset-paginated.

Security
PartnerApiKey and PartnerOAuth
Path
patientIdinteger, (int64)required

Patient ID (AccountPatient id)

accountIdinteger, (int64)required

Account identifier

Query
systemstring

Filter by system

Enum:"GHL""MX_MERCHANT"
idTypestring

Filter by external ID type. Only patient-scoped types are valid here; the location-level types (LOCATION_ID, MERCHANT_ID) are served by the location external-id endpoint.

Enum:"CONTACT_ID""OPPORTUNITY_ID""CUSTOMER_ID"
externalIdstring, [ 0 .. 255 ] characters

Filter by external ID value (exact match)

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}/patient/{patientId}/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"
}