Skip to content
Wazapin
Esc
↑↓navigate↵open⌘Jpreview

List CRM views

GET/v1/crm/views
Authorization
bearerAuthbearerAuthrequired
or
apiKeyAuthapiKeyAuthrequired
Query parameters
objectKindstring
sourceListIDstring
Responses
200OK
itemsCRMView[] | nullrequired
Show properties
Array of CRMView
columnsCRMViewColumn[] | null
Show properties
Array of CRMViewColumn
fieldstringrequired
hiddenboolean
labelstring
pinnedstring
positioninteger<int32>
sourcestring
widthinteger<int32>
created_atstringrequired
descriptionstring | nullrequired
display_typestringrequired
filtersCRMRecordFilter[] | null
Show properties
Array of CRMRecordFilter
fieldstringrequired
operatorstring
sourcestring
valueany
group_byCRMViewGroupBy[] | null
Show properties
Array of CRMViewGroupBy
directionstring
fieldstringrequired
sourcestring
idstringrequired
is_defaultboolean
is_pinnedboolean
metadataanyrequired
namestringrequired
object_kindstringrequired
row_heightstring
sortsCRMRecordSort[] | null
Show properties
Array of CRMRecordSort
directionstring
fieldstringrequired
sourcestring
source_list_idstring | nullrequired
updated_atstringrequired
visibilitystring
metaPaginationMetarequired
Show properties
cursorstring
has_morebooleanrequired
limitinteger<int64>required
next_cursorstring
offsetinteger<int64>
totalinteger<int64>
400Bad Request
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
401Unauthorized
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
403Forbidden
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
422Unprocessable Entity
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
500Internal Server Error
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
Request
curl -X GET "/v1/crm/views"
Response
{
  "items": [
    {
      "columns": [
        {
          "field": "string",
          "hidden": true,
          "label": "string",
          "pinned": "string",
          "position": 0,
          "source": "string",
          "width": 0
        }
      ],
      "created_at": "string",
      "description": "string",
      "display_type": "string",
      "filters": [
        {
          "field": "string",
          "operator": "string",
          "source": "string",
          "value": "string"
        }
      ],
      "group_by": [
        {
          "direction": "string",
          "field": "string",
          "source": "string"
        }
      ],
      "id": "string",
      "is_default": true,
      "is_pinned": true,
      "metadata": "string",
      "name": "string",
      "object_kind": "string",
      "row_height": "string",
      "sorts": [
        {
          "direction": "string",
          "field": "string",
          "source": "string"
        }
      ],
      "source_list_id": "string",
      "updated_at": "string",
      "visibility": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}