Skip to main content

Get Waitlist

Retrieve a specific waitlist from your store.

The body is a single waitlist object, the same shape as a list item.

Request​

GET /waitlists/{id}

Path Parameters​

ParameterTypeRequiredDescription
idstringYesWaitlist UUID.

Example Request​

curl -X GET "https://cart.easy.tools/api/v1/waitlists/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response​

Success Response (200)​

Returns one waitlist. This is the first item from Get Waitlists, with no items wrapper.

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "active",
"product_id": "6a7fdc8a-73c4-40bb-9996-16bc86486830",
"product_name": "Workshop",
"members_count": 1,
"created_at": "2026-09-01T10:15:30+00:00"
}

Response Fields​

Field reference: Waitlist object.

FieldTypeNullableDescription
idstringNoWaitlist UUID.
statusstringNoWaitlist status (see Status).
product_idstringNoProduct UUID.
product_namestringNoCurrent product name.
members_countintegerNoNumber of signups. Zero when nobody has joined.
created_atstringNoWhen the waitlist was created (ISO 8601).

Error Responses​

Bad Request (400)​

Returned when id is not a UUID.

{
"message": "Invalid waitlist ID"
}

Not Found Error (404)​

Returned when the waitlist does not exist in this store, or when its product no longer exists. A waitlist hidden by a list filter still returns 200 here.

{
"message": "Waitlist with ID 8d5c2e19-4f76-4a3b-9c14-1e6b55a40d3f not found"
}

Unauthorized Error (401)​

{
"message": "Unauthenticated."
}

Forbidden Error (403)​

Returned when your API key has not been granted access to the requested store.

{
"message": "You do not have API access to the requested store."
}

Rate Limit Error (429 Too Many Requests)​

Returned when you exceed the rate limit. The Retry-After response header gives the number of seconds to wait.

{
"message": "Too many requests. Please retry after 60 seconds."
}