Get Client

This endpoint returns one client by ID.

Endpoint

GET /v1/clients/clients/:id

Authentication

Include your API key in the x-api-key header. See Authentication.

Required Scope

clients:read

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Client ID.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

curl "https://api.crewsum.com/v1/clients/clients/client-ghi123jkl4567890" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

const response = await fetch(
  "https://api.crewsum.com/v1/clients/clients/client-ghi123jkl4567890",
  { headers: { "x-api-key": process.env.CREWSUM_API_KEY } },
);
const result = await response.json();

HTTP

GET /v1/clients/clients/client-ghi123jkl4567890 HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

On success, the API returns HTTP 200 OK.

Example Response

{
  "message": "Successfully fetched client: client-ghi123jkl4567890",
  "data": {
    "id": "client-ghi123jkl4567890",
    "name": "Client Name",
    "description": "A brief description of the client",
    "isArchived": false,
    "createdAt": "2026-01-05T15:30:00.000Z",
    "updatedAt": "2026-02-10T09:12:00.000Z",
    "isDeleted": false,
    "customFields": {
      "region": "west",
      "accountManager": "Jordan Lee"
    }
  }
}

Behavior

• The endpoint returns one client object in data.
• Deleted clients are still returned, with isDeleted: true.
• updatedAt is null for clients that were never updated.
• customFields is always present. It is {} when the client has no custom fields.

Error Responses

Status	Meaning
400	{"message": "ClientID missing"}. The ID path segment is empty.
404	{"message": "Client not found: <id>"}. No client with this ID exists in your account.

Authentication and scope failures are described in Errors.

Related Webhooks

This endpoint does not trigger a webhook.