List contacts, or create one with POST. derived from route
URL
User APIhttps://sales.mattering.io/api/user/v1/contacts/
Service tierhttps://sales.mattering.io/api/internal/contacts/
Query parameters
Name
Default
archived_only
none
created_after
none
created_before
none
fields
none
group_by
none
include_archived
none
sort
none
space_id
none
updated_after
none
updated_before
none
view
none
Body keys (JSON)
Key
Required
Default
custom_fields
optional or conditional
none
space_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Pagination
Accepts limit and offset. The response meta carries total, returned, has_more and next_offset.
Responses
200data and meta envelope, legacy keys repeated beside data
This read is not paginated. It returns at most 200 rows and does not report a total, so a result of exactly 200 may be truncated.
URL
User APIhttps://sales.mattering.io/api/user/v1/contacts/bulk/
Service tierhttps://sales.mattering.io/api/internal/contacts/bulk/
Body keys (JSON)
Key
Required
Default
dry_run
optional or conditional
none
match_on
optional or conditional
none
mode
optional or conditional
none
records
optional or conditional
none
space_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
User APIhttps://sales.mattering.io/api/user/v1/contacts/merge/
Service tierhttps://sales.mattering.io/api/internal/contacts/merge/
Body keys (JSON)
Key
Required
Default
duplicate_ids
optional or conditional
none
primary_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200data and meta envelope
{
"data": {
"...": "..."
}
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
This read is not paginated. It returns at most 200 rows and does not report a total, so a result of exactly 200 may be truncated.
URL
User APIhttps://sales.mattering.io/api/user/v1/contacts/upsert/
Service tierhttps://sales.mattering.io/api/internal/contacts/upsert/
Body keys (JSON)
Key
Required
Default
custom_fields
optional or conditional
none
domain
optional or conditional
none
dry_run
optional or conditional
none
email
optional or conditional
none
match_on
optional or conditional
none
name
optional or conditional
none
records
optional or conditional
none
space_id
optional or conditional
none
website
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Read, update or delete one of the contacts by id. derived from route
This read is not paginated. It returns at most 200 rows and does not report a total, so a result of exactly 200 may be truncated.
URL
User APIhttps://sales.mattering.io/api/user/v1/contacts/{contact_id}/
Service tierhttps://sales.mattering.io/api/internal/contacts/{contact_id}/
Path parameters
Name
Type
contact_id
str
Body keys (JSON)
Key
Required
Default
custom_fields
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200data and meta envelope, legacy keys repeated beside data
We use strictly necessary cookies to run this site. With your permission we also use analytics cookies
(Google Analytics and our own visit tracking) to see which pages work. Read the
Cookie notice.