Get a Record

From a record list

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

record-lists:manage

Body Response - Schema

200 (get a record)

ParameterTypeDescriptionRequired
idstringrecord IDno
record_list_idstringrecord list IDno
phone_numberstringphone number of the record (required if phone_numbers field is not present)deprecated
phone_numbersarray[object]

List of phone numbers of the record.

= 1 items

"phone_numbers" subdivides into:

1 - "phone_number" (string) - record phone number.

= 1 characters
<= 20 characters Required.

2 - "phone_type" (string) - The type of the phone number

= 4 characters
<= 7 characters
Allowed values: "HOME",
"OFFICE", "MOBILE",
"EXTRA_1", "EXTRA_2",
"EXTRA_3". Required.

no
first_namestring

First name of the record.

= 1 characters
<= 80 characters

no
last_namestring

Last name of the record.

= 1 characters
<= 80 characters

no
timezonestring

Timezone of the record.

= 1 characters
<= 35 characters

no
priorityinteger

Priority of the record within the record list.

= 1
<= 10

no
extra_dataobjectextra data of the recordno
external_providerstringreference for external provider sourceno
external_idstringunique identifier for resource in external sourceno
external_urlstringresource location in external sourceno
sync_external_idbooleansync external ID with contactsno
created_atstringrecord creation dateno
updated_atstringRecord update dateno
_linksstring

"_links" subdivides into:

1 - "self" (object)
1.1 - "href" (string)

no

401 (unauthorized), 403 (forbidden), 404 (resource not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]

"fields" subdivides into:

"name" (string)

"description" (string)

yes (name and description)
🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Credentials
Header
Click Try It! to start a request and see the response here!