Get customer

GET/workspaces/{organizationId}/customers/{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

Customer

idstringrequired

organizationIdstringrequired

namestringrequired

urlstring | nullrequired

domainstring | nullrequired

bookingUrlstring | nullrequired

notesstring | nullrequired

logoUrlstring | nullrequired

externalIdstring | nullrequired

phonestring | nullrequired

addressstring | nullrequired

verticalstring | nullrequired

neighborhoodstring | nullrequired

sourcestring | nullrequired

sourceSessionIdstring | nullrequired

sourceAgentSlugstring | nullrequired

readinessstring | nullrequired

nextActionstring | nullrequired

fitstring | nullrequired

fitScorenumber | nullrequired

fitStatusstring | nullrequired

processorstring | nullrequired

evidenceUristring | nullrequired

tierIdstring | nullrequired

statusIdstring | nullrequired

ownerIdstring | nullrequired

nextStepTextstring | nullrequired

nextStepDueAtstring | nullrequired

needsHumanboolean | nullrequired

needsHumanReasonstring | nullrequired

priorityScorenumber | nullrequired

customFieldsobjectrequired

createdAtstringrequired

updatedAtstringrequired

404

Customer 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/customers/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

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

Response

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "url": "string",
  "domain": "string",
  "bookingUrl": "string",
  "notes": "string",
  "logoUrl": "string",
  "externalId": "string",
  "phone": "string",
  "address": "string",
  "vertical": "string",
  "neighborhood": "string",
  "source": "string",
  "sourceSessionId": "string",
  "sourceAgentSlug": "string",
  "readiness": "string",
  "nextAction": "string",
  "fit": "string",
  "fitScore": 0,
  "fitStatus": "string",
  "processor": "string",
  "evidenceUri": "string",
  "tierId": "string",
  "statusId": "string",
  "ownerId": "string",
  "nextStepText": "string",
  "nextStepDueAt": "string",
  "needsHuman": true,
  "needsHumanReason": "string",
  "priorityScore": 0,
  "customFields": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "string",
  "updatedAt": "string"
}