Allo

Create view

Creates a saved view: a named filter and sort over people. Filter conditions are combined with AND. Returns 400 validation error with INVALID REQUEST BODY…

POST/v2/api/crm/views

Body fields

FieldTypeRequiredDescription
namestringyesDisplay name, up to 255 characters
filtersarrayno{ field, operator, value } conditions, combined with AND. Up to 50
sortarraynoUp to 2 { field, order } entries. order is asc or desc. field is a sortable built-in field (name, company, job_title, website, created_at, updated_at, last_activity) or the key of a sortable custom field from List custom fields
owner_typestringnoUSER (default, private to you) or TEAM (shared with your team)
{
  "name": "Hot leads",
  "filters": [
    {
      "field": "company",
      "operator": "CONTAINS",
      "value": "Acme"
    }
  ],
  "sort": [
    {
      "field": "created_at",
      "order": "desc"
    }
  ],
  "owner_type": "USER"
}

See Filters for the fields and operators you can use.

Response

Returns 201 with the view.

{
  "data": {
    "id": "cvw_2abc",
    "name": "Hot leads",
    "filters": [
      {
        "field": "company",
        "operator": "CONTAINS",
        "value": "Acme"
      }
    ],
    "sort": [
      {
        "field": "created_at",
        "order": "desc"
      }
    ],
    "owner_type": "USER",
    "user_id": "usr_2abc",
    "team_id": null,
    "created_at": "2026-10-23T10:00:00",
    "updated_at": "2026-10-23T10:00:00"
  }
}

Errors

StatusCodeWhen
400INVALID_REQUEST_BODYname is missing, blank or longer than 255 characters, filters has more than 50 entries, or owner_type is not USER or TEAM. Field-level problems are listed in errors[] with the field (name or filters)
400INVALID_FILTER_FIELDA filter field is neither a built-in person field nor the key of a custom field from GET /v2/api/crm/attributes. param is filters
400INVALID_FILTER_OPERATORA filter operator does not match the type of its field. The message names the field. param is filters
400INVALID_FILTER_VALUEA filter value cannot be read for the type of its field: a number field needs a numeric value, a date field needs an ISO 8601 date such as 2026-01-31 or 2026-01-31T00:00:00Z. The message names the value and the field. param is filters
400INVALID_SORT_FIELDA sort field is neither a built-in field nor a custom field key from GET /v2/api/crm/attributes. param is sort
400FIELD_NOT_SORTABLEA sort field exists but cannot be sorted on. Use a built-in sortable field or a sortable custom field. param is sort
400USER_HAS_NO_TEAMowner_type is TEAM but you do not belong to a team. Use USER. param is owner_type
403API_KEY_INSUFFICIENT_SCOPEThe key does not hold CRM_WRITE

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Body

namestringrequired
filtersobject[]

Conditions combined with AND. At most 50

3 fields
fieldstringrequired

A built-in person field (name, company, job_title, emails, phone_numbers, website, addresses, created_at, updated_at, last_activity, activity_history, sms_content (only when the team has SMS)) or the key of a custom field from GET /v2/api/crm/attributes. An unknown field returns 400 INVALID_FILTER_FIELD

operatorenum<string>required

Comparison operator. It must match the type of the field, otherwise the request returns 400 INVALID_FILTER_OPERATOR

ISIS_NOTCONTAINSNOT_CONTAINSEMPTYNOT_EMPTYSTARTS_WITHENDS_WITHBEFOREAFTERDATE_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALHAS

valuestringrequired

Value to compare to. It must be readable for the type of the field, otherwise the request returns 400 INVALID_FILTER_VALUE: numeric for a number field, an ISO 8601 date such as 2026-01-31 or date-time such as 2026-01-31T00:00:00Z for a date field. Ignored for EMPTY and NOT_EMPTY

sortobject[]

Up to 2 entries. Sortable built-in fields: name, company, job_title, website, created_at, updated_at, last_activity. A sortable custom field key from GET /v2/api/crm/attributes also works

2 fields
fieldstringrequired

A sortable built-in person field (name, company, job_title, website, created_at, updated_at, last_activity) or the key of a sortable custom field from GET /v2/api/crm/attributes

orderenum<string>required

ascdesc

owner_typeenum<string>

USER is private to the API key's user. TEAM is shared with the user's team; it returns 400 USER_HAS_NO_TEAM when the user has no team.

USERTEAM

Responses

201The view that was created
dataobject

A saved view: a named filter and sort over people. Views created in the Allo app and with the API are the same objects.

9 fields
idstring

Public ID of the view

namestring
filtersobject[]
3 fields
fieldstringrequired

A built-in person field (name, company, job_title, emails, phone_numbers, website, addresses, created_at, updated_at, last_activity, activity_history, sms_content (only when the team has SMS)) or the key of a custom field from GET /v2/api/crm/attributes. An unknown field returns 400 INVALID_FILTER_FIELD

operatorenum<string>required

Comparison operator. It must match the type of the field, otherwise the request returns 400 INVALID_FILTER_OPERATOR

ISIS_NOTCONTAINSNOT_CONTAINSEMPTYNOT_EMPTYSTARTS_WITHENDS_WITHBEFOREAFTERDATE_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALHAS

valuestringrequired

Value to compare to. It must be readable for the type of the field, otherwise the request returns 400 INVALID_FILTER_VALUE: numeric for a number field, an ISO 8601 date such as 2026-01-31 or date-time such as 2026-01-31T00:00:00Z for a date field. Ignored for EMPTY and NOT_EMPTY

sortobject[]
2 fields
fieldstringrequired

A sortable built-in person field (name, company, job_title, website, created_at, updated_at, last_activity) or the key of a sortable custom field from GET /v2/api/crm/attributes

orderenum<string>required

ascdesc

owner_typeenum<string>

USER is private to the API key's user. TEAM is shared with the user's team.

USERTEAM

user_idstring | null

ID of the user who owns a USER view

team_idstring | null

ID of the team a TEAM view belongs to

created_atstring
updated_atstring
400
401
403
429