v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Person API

Get person by external_person_id

get/companies/{company_key}/mobiledb/persons/external/{external_person_id}

Path parameters

company_keystring required

external_person_idstring required

Headers

X-API-Versionstring

Response

Successful response

person_keystring

A unique Vibes-asigned alphanumeric identifier for each person record.

external_person_idstring

A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Max 128 characters.

custom_fieldsobject

list of custom field key/value pairs.

created_atstring

The date this person was created, in the ISO-8601 format.

updated_atstring

The date this person was last updated, in the ISO-8601 format.

urlstring