Get End Customer
This endpoint returns one end customer by ID.
Endpoint
Section titled “Endpoint”GET /v1/end-customers/end-customers/:idAuthentication
Section titled “Authentication”Include your API key in the x-api-key header. See Authentication.
Required Scope
Section titled “Required Scope”end-customers:readPath Parameters
Section titled “Path Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | End customer ID. |
Request Body
Section titled “Request Body”This endpoint does not accept a request body.
Example Request
Section titled “Example Request”curl "https://api.crewsum.com/v1/end-customers/end-customers/endcustomer-abc123def4567890" \ -H "x-api-key: $CREWSUM_API_KEY"const response = await fetch( "https://api.crewsum.com/v1/end-customers/end-customers/endcustomer-abc123def4567890", { headers: { "x-api-key": process.env.CREWSUM_API_KEY } },);const result = await response.json();GET /v1/end-customers/end-customers/endcustomer-abc123def4567890 HTTP/1.1Host: api.crewsum.comx-api-key: <your-api-key>Response
Section titled “Response”On success, the API returns HTTP 200 OK.
Example Response
Section titled “Example Response”{ "message": "Successfully fetched end customer: endcustomer-abc123def4567890", "data": { "id": "endcustomer-abc123def4567890", "name": "End Customer Name", "description": "A brief description", "clientId": "client-ghi123jkl4567890", "clientName": "Client Name", "clientArchived": false, "clientDeleted": false, "email": "buyer@example.com", "phoneNumber": "555-0100", "address": "123 Main St", "notes": "Important delivery requirements", "isArchived": false, "createdAt": "2026-01-05T15:30:00.000Z", "updatedAt": "2026-02-10T09:12:00.000Z", "isDeleted": false }}Behavior
Section titled “Behavior”- The endpoint returns one end customer object in
data. - Deleted end customers are still returned, with
isDeleted: true. - End customers without a client return
nullforclientId,clientName,clientArchived, andclientDeleted. updatedAtisnullfor end customers that were never updated.
Error Responses
Section titled “Error Responses”| Status | Meaning |
|---|---|
400 | {"message": "EndCustomerID missing"}. The ID path segment is empty. |
404 | {"message": "End customer not found: <id>"}. No end customer with this ID exists in your account. |
Authentication and scope failures are described in Errors.
Related Webhooks
Section titled “Related Webhooks”This endpoint does not trigger a webhook.