List support agents

GET/workspaces/{organizationId}/support/agents

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

organizationIdstringrequired

Responses

200

Agents

agentsobject[]required

Show properties

Array of object

userIdstringrequired

namestringrequired

emailstringrequired

statusstringrequired

Allowed:activeawaysnoozedoffline

untilstring<date-time> | null

openTicketsintegerrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Request

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

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

import requests

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

Response

{
  "agents": [
    {
      "userId": "string",
      "name": "string",
      "email": "string",
      "status": "active",
      "until": "2019-08-24T14:15:22Z",
      "openTickets": 0
    }
  ]
}