Skip to main content
Retrieve detailed information about a specific supplier using its ID.

​
Endpoint

GET /api/v1/suppliers/{id}

​
Path Parameters

​
id
integer
required
The unique identifier of the supplier

​
Response

Returns a supplier object.
​
id
integer
required
Unique identifier for the supplier
​
name
string
required
Name of the supplier
​
contactEmail
string
required
Contact email address for the supplier
​
contactPhone
string
required
Contact phone number for the supplier
​
isActive
boolean
required
Indicates whether the supplier is currently active

​
Example Request

curl https://api.example.com/api/v1/suppliers/1

​
Example Response

{
  "id": 1,
  "name": "Premium Furniture Co.",
  "contactEmail": "[email protected]",
  "contactPhone": "+1-555-0100",
  "isActive": true
}

​
Status Codes

  • 200 OK - Supplier found and returned successfully
  • 404 Not Found - Supplier with the specified ID does not exist

​
Error Response

If the supplier is not found, the API returns a 404 status code: 
{
  "status": 404,
  "error": "Not Found",
  "message": "Supplier not found with id: 1"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us