Get Supplier

This endpoint returns one supplier by ID.

Endpoint

GET /v1/suppliers/suppliers/:id

Authentication

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

Required Scope

suppliers:read

Path Parameters

Parameter	Type	Required	Description
`id`	`string`	Yes	Supplier ID, for example `supplier-stu123vwx4567890`.

Request Body

This endpoint does not accept a request body.

Example Request

curl "https://api.crewsum.com/v1/suppliers/suppliers/supplier-stu123vwx4567890" \
  -H "x-api-key: $CREWSUM_API_KEY"

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

GET /v1/suppliers/suppliers/supplier-stu123vwx4567890 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 supplier",
  "data": {
    "id": "supplier-stu123vwx4567890",
    "name": "Supplier Name",
    "description": "A brief description of the supplier",
    "isArchived": false,
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-02T00:00:00.000Z",
    "isDeleted": false
  }
}

Behavior

This endpoint returns archived and deleted suppliers. Check isArchived and isDeleted in the response.
updatedAt is null until the supplier is updated for the first time.

Error Responses

Status	Meaning
`400`	The ID path segment was empty (for example, a trailing slash). Message: `SupplierID not provided`.
`404`	Message: `Supplier not found`. The API returns this for an unknown ID and also for any other failure, including database errors.

Authentication and scope failures are described in Errors.

This endpoint does not trigger a webhook.