custom-objects
Search for custom objects by a given filter
Filterable fields and their allowed operators:
| Field | Allowed operators |
|---|---|
| name | equals, in, not_in, string_contains, string_does_not_contain, is_set, is_unset |
| created_at | time_is_after, time_is_before, time_range |
| updated_at | time_is_after, time_is_before, time_range |
Timestamp values use RFC3339 format. For custom fields, pass the field slug as field.
Rate limit: 120 requests per minute
post/custom-objects/{type}/search
Path parameters
typestring required
The type slug of the custom object (e.g. "companies").
Request body
Example request
{
"filter": {
"subfilters": [
{
"field": "state",
"operator": "equals",
"value": "new"
}
]
}
}Response
Example response
{
"data": [
{
"custom_fields": {
"priority": {
"value": "high"
}
}
}
]
}