Sends the owner a reminder email to update their subscription so more agents can be created.

Allowed For

• Agents

Returns an array of users who meet the search criteria.

Pagination

• Offset pagination only

See Using Offset Pagination.

Allowed For

• Admins, Agents and Light Agents

Accepts a comma-separated list of up to 100 user ids or external ids.

Allowed For:

• Agents

Deletes the user and associated records from the account.

Warning:

• Deleted users are not recoverable.
• Both agents and administrators can soft delete users in the agent interface in Zendesk Support. Agents with permission can delete end users, while administrators can delete all users except the account owner.

To comply with GDPR, a further step is needed. See Permanently Delete User.

Allowed For

• Admins and agents in custom roles with permission to manage end users or team members

Allowed For

• Agents

Returns the GDPR status for each user per area of compliance. A Zendesk area of compliance is typically a product like “support/explore” but can be more fine-grained for areas within the product lines.

If the user is not in the account, the request returns a 404 status.

Status: 404
{
  "error":"RecordNotFound",
  "description":"Not found"
}

Allowed For

• Agents, with restrictions

Pagination

• Cursor pagination (recommended)
• Offset pagination

See Pagination.

Merges the end user specified in the path parameter into the existing end user specified in the request body.

Any two end users can be merged with the exception of end users created by sharing agreements.

Agents and admins cannot be merged.

For more information about how user data is merged, see Merging a user’s duplicate account in Zendesk help.

Allowed For

• Admins or agents with permission to edit end users

Lists shared and personal views available to the current user.

Sideloads

The following sideloads are supported:

Pagination

• Cursor pagination (recommended, but only sorts by created_at)
• Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

• Agents

Allowed For

• Agents

JSON Format

The JSON format consists of one property, a view object that lists the values to set when the view is created.

Note: The request must include at least one condition in the all array that checks one of the following fields: status, type, group_id, assignee_id, or requester_id.

The restriction object has the following properties.

If type is “Group”, the ids property is the preferred method of specifying the group id or ids.

Example Request Body

{
  "view": {
    "title": "Kelly's tickets",
    "raw_title": "{{dc.tickets_assigned_to_kelly}}",
    "description": "Tickets that are assigned to Kelly",
    "active": true,
    "position": 3,
    "restriction": {
      "type": "User",
      "id": "213977756"
    },
    "all": [
      {
        "field": "status",
        "operator": "less_than",
        "value": "solved"
      },
      {
        "field": "group_id",
        "operator": "is",
        "value": "24000932"
      },
      {
        "field": "custom_fields_360011872073",
        "operator": "is",
        "value": "Canada"
      },
      ...
    ],
    "output": {
      "columns": ["status", "requester", "assignee"],
      "group_by": "assignee",
      "group_order": "desc",
      "sort_by": "status",
      "sort_order": "desc"
    }
  }
}

View columns

The output request parameter lets you specify what columns to include in the view in the agent interface. Example: "output": {"columns": ["status", "description", "priority"]}. The following table lists possible columns for views in the agent UI and the corresponding values in the columns array.

For custom fields, specify the id of the custom field in the columns array.

You can specify a total of 10 columns to a view.

View sorting

You can group and sort items in the view by adding items to the output parameter:

Lists active shared and personal views available to the current user.

Sideloads

The following sideloads are supported:

Pagination

• Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

• Agents

A compacted list of shared and personal views available to the current user. This endpoint never returns more than 32 records and does not respect the “per_page” option.

Allowed For

• Agents

Returns an approximate count of shared and personal views available to the current user. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours.

The count[refreshed_at] property is a timestamp that indicates when the count was last updated.

Note: When the count exceeds 100,000, count[refreshed_at] may occasionally be null.
This indicates that the count is being updated in the background, and count[value] is limited to 100,000 until the update is complete.

Allowed For

• Agents

Returns the ticket count of each view in a list of views. Accepts up to 20 view ids per request. For the ticket count of a single view, see Count Tickets in View.

Only returns values for personal and shared views accessible to the user performing the request.

This endpoint is rate limited to 6 requests every 5 minutes.

Allowed For

• Agents

Deletes the views corresponding to the provided list of IDs.

Allowed For

• Agents

You can preview views by constructing the conditions in the proper format and nesting them under the view property. See Conditions reference. The output can also be controlled by passing in any of the following parameters and nesting them under the output property.

This endpoint is rate limited to 5 requests per minute, per view, per agent.

Allowed For

• Agents

Returns the ticket count for a single preview.

Allowed For

• Agents

Pagination

• Offset pagination only

See Using Offset Pagination.

Allowed For

• Agents

Sideloads

The following sideloads are supported. For more information, see Side-loading.

Allowed For

• Agents

Sideloads

The following sideloads are supported:

Allowed For

• Agents

Request Parameters

The PUT request expects a views object that lists the views to update.

Each view may have the following properties:

Example Request Body

{
  "views": [
    {"id": 25, "position": 3},
    {"id": 23, "position": 5},
    {"id": 27, "position": 9},
    {"id": 22, "position": 7}
  ]
}

Allowed For

• Agents

Allowed For

• Agents

Allowed For

• Agents

JSON Format

The PUT request takes one property, a view object that lists the values to update. All properties are optional.

Note: Updating a condition updates the containing array, clearing the other conditions. Include all your conditions when updating any condition.

The restriction object has the following properties.

If type is “Group”, the ids property is the preferred method of specifying the group id or ids.

You can also update how items are sorted and grouped. See View sorting in Create View.

Example Request Body

{
  "view": {
    "title": "Code red tickets",
    "restriction": {
      "type": "Group",
      "ids": [10052, 10057, 10062, 10002]
    },
    "all": [
      {
        "field": "priority",
        "operator": "is",
        "value": "urgent"
      }
    ],
    "output": {
      "columns": ["status", "requester", "assignee", "updated"]
    }
  }
}

Returns the ticket count for a single view.

This endpoint is rate limited to 5 requests per minute, per view, per agent.

View Counts

The view count endpoints, Count Tickets in View (this endpoint) and Count Tickets in Views, let you estimate how many tickets remain in a view without having to retrieve the entire view. They’re designed to help estimate view size. From a business perspective, accuracy becomes less relevant as view size increases.

To ensure quality of service, these counts are cached more heavily as the number of tickets in a view grows. For a view with thousands of tickets, you can expect the count to be cached for 60-90 minutes. As a result, the count may not reflect the actual number of tickets in your view.

View counts are represented as JSON objects with the following attributes:

Example

{
  "view_count": {
    "view_id": 25,
    "url":     "https://company.zendesk.com/api/v2/views/25/count.json",
    "value":   719,
    "pretty":  "~700",
    "fresh":   true
  }
}

Returns the column titles and the rows of the specified view.

The columns array lists the view’s column titles and includes only views parameters.

The rows array lists the values of each column for each ticket and includes parameters from both views and tickets. Though not displayed in the view, a partial ticket object is included with each row object.

Note: To get the full ticket objects for a specified view, use List Tickets from a View.

This endpoint is rate limited to 5 requests per minute, per view, per agent.

The view execution system is designed for periodic rather than high-frequency API usage. In particular, views called very frequently may be cached by Zendesk. This means that the API client will still receive a result, but that result may have been computed at any time within the last 10 minutes.

Zendesk recommends using the Incremental Ticket Export endpoint to get the latest changes. You can call it more often, and it returns all the tickets that changed since the last poll. For details and rate limits, see Incremental Exports.

View output sorting can be controlled by passing the sort_by and sort_order parameters in the format described in the table in Preview Views.

Allowed For

• Agents

Pagination

• Cursor pagination (recommended)
• Offset pagination

See Pagination.

Returns the csv attachment of the specified view if possible. Enqueues a job to produce the csv if necessary.

Allowed For

• Agents

Allowed For

• Agents

Pagination

• Cursor pagination (recommended)
• Offset pagination

See Pagination.

Allowed For

• Admins, Agents

Allowed For

• Admins

Allowed For

• Admins

Allowed For

• Admins

Allowed For

• Admins

Allowed For

• Admins

Allowed For

• Admins

Allowed For

• Admins
• Agents

Allowed For

• Admins
• Agents

Turns a tweet into a ticket. You must provide the tweet id as well as the id of a monitored X (formerly Twitter) handle configured for your account.

The submitter of the ticket is set to be the user submitting the API request.

Allowed For

• Agents

Allowed For

• Agents