younifyd
Menu

List Views

List views

GET/api/views

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the List Views action (under Views).
  3. Fill in the fields below, then reference the result from later steps as {{listViews.response.data}}.

Request

Query parameters

order_bystring

Attribute used to order views.

One ofcreated_datetime:asccreated_datetime:descDefault "created_datetime:desc"

cursorstring

Value indicating your position in the list of all views. If omitted, the first views of the list will be returned.

limitinteger

Maximum number of views to return.

Default 30

categorystring

Filter views by category. Use 'system' to fetch only system views, 'user' to fetch only user views.

One ofsystemuser

Response

Returns 200 with an object. Read it in later steps with {{listViews.response.data.<field>}}.

objectstring
uristring
dataarray<object>
idintegerrequired

ID of the view.

categorystring

Category is an internal, read-only field used to identify system and user views.Example of system views: Trash or Spam. System views cannot be deleted.

Default "user"

created_datetimestring (date-time)

When the view was created.

deactivated_datetimestring (date-time)

When the view was deactivated.

decorationobject1 fields
fieldsarray<string>

List of object's attributes to be displayed in the UI of our applications.

filtersstring

The logic used to filter the items to be displayed in the view (as JavaScript code).

namestring

The name of the view.

Default ""

order_bystring

Name of the object's attribute used to sort the items of the view.

Default "updated_datetime"

order_dirstring

Sort direction of the items displayed in the view. Options: `asc` or `desc`.

One ofascdescDefault "desc"

searchstring

Text used to search for items matching the query.

shared_with_teamsarray<object>3 fields

Teams this view is shared with.

Default []

shared_with_usersarray<object>3 fields

Users this view is shared with.

Default []

slugstring

DEPRECATED - URL-compatible name of the view.

typestring

One ofticket-listcustomer-list

uristringrequired

URI of the object (auto-generated)

visibilitystring

One ofpublicsharedprivate

metaobject
prev_cursorstringrequired
next_cursorstringrequired
total_resourcesintegerrequired
json
{
  "object": "string",
  "uri": "string",
  "data": [
    {
      "id": 0,
      "uri": "string",
      "category": "user",
      "created_datetime": "2025-01-01T00:00:00Z",
      "deactivated_datetime": "2025-01-01T00:00:00Z",
      "decoration": {
        "emoji": "string"
      },
      "fields": [
        "id"
      ],
      "filters": "string",
      "name": "",
      "order_by": "updated_datetime",
      "order_dir": "desc",
      "search": "string"
    }
  ],
  "meta": {
    "prev_cursor": "string",
    "next_cursor": "string",
    "total_resources": 0
  }
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?