Next Commerce
Support

Tickets List

Retrieve a list of tickets.

GET
/tickets/

Authorization

oauth2 tickets:read
AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: tickets:read

Query Parameters

filter_text?string

Generic search by ticket id, subject, or requester email.

id?integer
subject?string

Subject

status?array<>
  • new - New
  • open - Open
  • pending - Pending
  • solved - Solved
  • closed - Closed
requester?integer

Requester

assignee?integer

Assignee

order_number?string

Order Number

product?array<>
tags?array<>

Tags

ticket_type?integer
priority?string
  • high - High
  • medium - Medium
  • low - Low
Value in"high" | "low" | "medium"
channel?string
  • customer_account - Customer account
  • dashboard - Dashboard
  • email - Email
  • api - API
  • follow_up - Follow up
Value in"api" | "customer_account" | "dashboard" | "email" | "follow_up"
created_from?string

Created From

Formatdate
created_to?string

Created To

Formatdate
cursor?string

The pagination cursor value.

Header Parameters

X-29next-API-Version*string
Default"unstable"
Value in"unstable"

Response Body

application/json

curl -X GET "https://example.29next.store/api/admin/tickets/" \
  -H "X-29next-API-Version: unstable" \
  -H "Authorization: Bearer "
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "assignee": 0,
      "channel": "customer_account",
      "comments": [
        {
          "attachments": [
            {
              "file": "http://example.com",
              "file_name": "string",
              "id": 0
            }
          ],
          "author": 0,
          "body": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "from_email": "user@example.com",
          "id": 0,
          "is_public": true
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "from_email": "user@example.com",
      "id": 0,
      "order": "string",
      "priority": "high",
      "products": [
        0
      ],
      "requester": 0,
      "status": "new",
      "subject": "string",
      "tags": [
        "string"
      ],
      "ticket_type": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}