Skip to content

Get End Customer

This endpoint returns one end customer by ID.

GET /v1/end-customers/end-customers/:id

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

end-customers:read
ParameterTypeRequiredDescription
idstringYesEnd customer ID.

This endpoint does not accept a request body.

Terminal window
curl "https://api.crewsum.com/v1/end-customers/end-customers/endcustomer-abc123def4567890" \
-H "x-api-key: $CREWSUM_API_KEY"

On success, the API returns HTTP 200 OK.

{
"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
}
}
  • The endpoint returns one end customer object in data.
  • Deleted end customers are still returned, with isDeleted: true.
  • End customers without a client return null for clientId, clientName, clientArchived, and clientDeleted.
  • updatedAt is null for end customers that were never updated.
StatusMeaning
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.

This endpoint does not trigger a webhook.