List customer statuses

GET/workspaces/{organizationId}/customer-statuses

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

Customer statuses

statusesobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

namestringrequired

keystring | nullrequired

typestringrequired

colorstring | nullrequired

positionnumberrequired

createdAtstringrequired

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/customer-statuses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

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

Response

{
  "statuses": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "key": "string",
      "type": "string",
      "color": "string",
      "position": 0,
      "createdAt": "string"
    }
  ]
}