Create View

Create a view

POST/api/views

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Create View action (under Views).
Fill in the fields below, then reference the result from later steps as {{createView.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

decorationobject

emojistring

Emoji displayed before the view's name.

fieldsarray<string>

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

Default []

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"

shared_with_teamsarray<integer>

IDs of teams this view is shared with.

Default []

shared_with_usersarray<integer>

IDs of users this view is shared with.

Default []

slugstringrequired

DEPRECATED - URL-compatible name of the view.

typestring

One ofticket-listcustomer-list

visibilitystring

One ofpublicsharedprivate

json

{
  "slug": "string",
  "decoration": {
    "emoji": "string"
  },
  "fields": [],
  "filters": "string",
  "name": "",
  "order_by": "updated_datetime",
  "order_dir": "desc",
  "shared_with_teams": [],
  "shared_with_users": [],
  "type": "ticket-list",
  "visibility": "public"
}

Response

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

idinteger

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.

decorationobject

emojistring

Emoji displayed before the view's name.

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>

Teams this view is shared with.

Default []

idintegerrequired

ID of the team.

namestringrequired

Name of the team.

decorationobject

Object describing how the team appears on the webpage. Currently only supports `emoji` field that shows before the team's name.

Default {}

shared_with_usersarray<object>

Users this view is shared with.

Default []

idintegerrequired

ID of the user.

namestringrequired

Name of the user.

metaobject

User defined JSON field with additional info about the user.

slugstring

DEPRECATED - URL-compatible name of the view.

typestring

One ofticket-listcustomer-list

uristring

URI of the object (auto-generated)

visibilitystring

One ofpublicsharedprivate

json

{
  "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"
}

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

Was this page helpful?