Get customer statuse

GET/workspaces/{organizationId}/customer-statuses/{id}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

organizationIdstringrequired

idstringrequired

Responses

200

Status

idstringrequired

organizationIdstringrequired

namestringrequired

keystring | nullrequired

typestringrequired

colorstring | nullrequired

positionnumberrequired

createdAtstringrequired

404

Status 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*idpath*

Request

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

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

import requests

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

Response

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