List support inbox

GET/workspaces/{organizationId}/support/inbox

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Query parameters

statusstring

Allowed:tododonesnoozed

prioritystring

Allowed:lowmediumhighurgent

assignedTostring

customerIdstring

channelstring

Allowed:emailslackmsteamsdiscordchatcaptureapiintercomzendeskplain

labelstring

qstring

limitinteger

min 1 · max 100 · default: 25

cursorstring

Responses

200

Inbox tickets

ticketsobject[]required

Show properties

Array of object

idstringrequired

numberintegerrequired

titlestringrequired

statusstringrequired

Allowed:tododonesnoozed

prioritystringrequired

Allowed:lowmediumhighurgent

customerobjectrequired

Show properties

idstringrequired

emailstringrequired

fullNamestring | null

primaryAssigneestring

labelsstring[]required

lastCustomerMessageAtstring<date-time>

lastAgentMessageAtstring<date-time>

createdAtstring<date-time>required

updatedAtstring<date-time>required

nextCursorstring | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*statusquerypriorityqueryassignedToquerycustomerIdquerychannelquerylabelqueryqquerylimitquerycursorquery

Request

curl -X GET 'https://pile.nyc/workspaces/string/support/inbox' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/string/support/inbox", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/string/support/inbox",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "tickets": [
    {
      "id": "string",
      "number": 0,
      "title": "string",
      "status": "todo",
      "priority": "low",
      "customer": {
        "id": "string",
        "email": "string",
        "fullName": "string"
      },
      "primaryAssignee": "string",
      "labels": [
        "string"
      ],
      "lastCustomerMessageAt": "2019-08-24T14:15:22Z",
      "lastAgentMessageAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}