Skip to navigation
API referencePartner

List your restaurants

Partner key alone. Lists the partner’s restaurants, sorted by slug and paginated with a cursor. A test key sees only sandboxes; a live key would see only real restaurants. Archived restaurants are included (archived: true).

No contact details, payment status or customer data. Use GET /partner/restaurants/{slug} with the restaurant key for details.

This call is not written to the API log in the partner portal, because it is not about one restaurant.

Authentication

AuthorizationBearer

The partner key, sent as Authorization: Bearer lbp_test_…. Created in the partner portal under Partner key. It belongs to the partner, not to a restaurant, and only works against /api/v1/partner. Server to server only: a request with an Origin header is rejected with 403 FORBIDDEN. A test key sees and creates only sandboxes; live partner keys are not available yet. A revoked key, a restaurant key (lbs_…) here, or a suspended or archived partner returns 401 UNAUTHORIZED; an expired key returns 401 KEY_EXPIRED.

Query parameters

cursorstringOptional<=32 characters

nextCursor from the previous page. Leave it out for the first page.

limitintegerOptional1-100Defaults to 25

Restaurants per page, 1–100. Defaults to 25.

Response headers

X-Request-IdstringOptional
Unique identifier for this response. The value is also present as error.requestId on errors.

Response

One page of restaurants. nextCursor is null on the last page.

datalist of objects
nextCursorstring or null

Send as cursor to get the next page. null on the last page.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error