Get support escalation rule

GET/workspaces/{organizationId}/support/escalation-rules/{ruleId}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

organizationIdstringrequired

ruleIdstringrequired

Responses

200

Rule

ruleobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

namestringrequired

isActivebooleanrequired

sortOrdernumberrequired

conditionsobjectrequired

Show properties

keywordsstring[]

channelsstring[]

prioritiesstring[]

statusesstring[]

sourcesstring[]

customerDomainsstring[]

actionobjectrequired

Show properties

typestringrequired

Allowed:create_issue

teamIdstring

prioritystring

Allowed:lowmediumhighurgent

statusstring

Allowed:triagebacklogtodoin_progressdonecanceled

labelIdsstring[]

agentIdstring

repostring

instructionsstring

createdAtstringrequired

updatedAtstringrequired

404

Not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*ruleIdpath*

Request

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

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

import requests

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

Response

{
  "rule": {
    "id": "string",
    "organizationId": "string",
    "name": "string",
    "isActive": true,
    "sortOrder": 0,
    "conditions": {
      "keywords": [
        "string"
      ],
      "channels": [
        "email"
      ],
      "priorities": [
        "low"
      ],
      "statuses": [
        "todo"
      ],
      "sources": [
        "intercom"
      ],
      "customerDomains": [
        "string"
      ]
    },
    "action": {
      "type": "create_issue",
      "teamId": "string",
      "priority": "low",
      "status": "triage",
      "labelIds": [
        "string"
      ],
      "agentId": "string",
      "repo": "string",
      "instructions": "string"
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}