Skip to content

Contacts

Contacts are the core records in Driftwood — the people your team interacts with. Contacts can be associated with companies, tagged, and have custom fields.

FieldTypeDescription
iduuid
account_iduuid
created_byuuid
first_namestring
last_namestring
emailstring
phonestring
company_iduuid?
company_namestring
job_titlestring
addressstring
citystring
statestring
zip_codestring
countrystring
notesstring
tagsstring[]
source_iduuid?
source_namestring
custom_fieldsobject
created_atdatetime
updated_atdatetime

Endpoint: contacts-create

FieldTypeRequiredDescription
first_namestringYes
last_namestringNo
emailstringNo
phonestringNo
company_idstring?No
job_titlestringNo
addressstringNo
citystringNo
statestringNo
zip_codestringNo
countrystringNo
notesstringNo
tagsstring[]No
source_idstring?No
custom_fieldsobject?No
Terminal window
curl -X POST https://api.driftwoodapp.com/api/contacts-create \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"first_name": "..."}'

Endpoint: contacts-delete

FieldTypeRequiredDescription
idstringYes
Terminal window
curl -X POST https://api.driftwoodapp.com/api/contacts-delete \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"id": "..."}'

Endpoint: contacts-get

FieldTypeRequiredDescription
idstringYes
Terminal window
curl -X POST https://api.driftwoodapp.com/api/contacts-get \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"id": "..."}'

List contacts with filtering and pagination

Section titled “List contacts with filtering and pagination”

Endpoint: contacts-list

FieldTypeRequiredDescription
searchstringNo
tagsstring[]No
company_idstring?No
company_idsstring[]No
source_idsstring[]No
cursorstringNo
limitintNo
Terminal window
curl -X POST https://api.driftwoodapp.com/api/contacts-list \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

Endpoint: contacts-update

FieldTypeRequiredDescription
idstringYes
first_namestring?No
last_namestring?No
emailstring?No
phonestring?No
company_idstring?No
job_titlestring?No
addressstring?No
citystring?No
statestring?No
zip_codestring?No
countrystring?No
notesstring?No
tagsstring[]No
source_idstring?No
custom_fieldsobject?No
Terminal window
curl -X POST https://api.driftwoodapp.com/api/contacts-update \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"id": "..."}'
CodeDescription
contacts.first_name_requiredFirst name required
contacts.invalid_company_idInvalid company id
contacts.invalid_source_idInvalid source id
contacts.invalid_custom_fieldsInvalid custom fields
contacts.invalid_idInvalid id
contacts.not_foundNot found