Skip to main content
GET
Retrieve a contact by an identifier

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Query Parameters

type
enum<string>
required

Identifier the value is given as.

Available options:
ID,
EMAIL,
PHONE
value
string
required

The identifier itself, in the form named by type. A PHONE is read like the cellphone of a contact write: a number without a country code is read in the workspace's default country, and spacing and separators are ignored. An EMAIL has its domain lowercased, but its local part is matched exactly as sent.

Required string length: 1 - 320

Response

Successful Response

Response body for contact-related operations.

id
string
required

Unique identifier for the contact (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

workspaceId
string
required

Unique identifier of the workspace this contact belongs to

Example:

"92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5"

type
enum<string>
required

NORMAL when all required identity and custom attribute fields are present, PARTIAL otherwise.

Available options:
PARTIAL,
NORMAL
Examples:

"NORMAL"

"PARTIAL"

createdAt
string
required

Timestamp when the contact was created.

Example:

"2003-04-10T08:00:00.000Z"

updatedAt
string
required

Timestamp when the contact was last updated.

Example:

"2003-04-10T08:00:00.000Z"

firstName
string | null

Contact's first name.

Example:

"John"

lastName
string | null

Contact's last name.

Example:

"Doe"

email
string<email> | null

Contact's email address.

Example:

"john.doe@example.com"

cellphone
string<phone> | null

Contact's cellphone address.

Example:

"+14084029292"

customAttributes
CustomAttributeResponse · object[]

Array of custom key-value attributes.

languageCode
enum<string> | null

Language code from external user.

Available options:
ES,
EN,
AF,
SQ,
AR,
AZ,
BN,
BG,
CA,
ZH_CN,
HR,
CS,
DA,
NL,
ET,
FIL,
FI,
FR,
KA,
DE,
EL,
GU,
HA,
HE,
HI,
HU,
ID,
GA,
IT,
JA,
KN,
KK,
RW_RW,
KO,
KY_KG,
LO,
LV,
LT,
MK,
MS,
ML,
MR,
NB,
FA,
PL,
PT_BR,
PA,
RO,
RU,
SR,
SK,
SL,
SW,
SV,
TA,
TE,
TH,
TR,
UK,
UR,
UZ,
VI,
ZU
Example:

"EN"

ownerId
string | null

Id of the Bridge User who owns this contact. Resolve it with GET /users/{userId}.

Example:

"37673840-6259-40f9-bbe5-a7db40f8e3cf"