Skip to content
CibusyDevelopers
TREN
Get an API key

Venues

List venues

The venues the API key can read, its own first.

GET/public/v1/venues
Authentication

An API key in the X-Api-Key header

Permission
Can read the menu (every key has it)
Rate limit
About 120 requests a minute per key

The key's own venue always comes first. For a key made for a headquarter, each of its branches follows, ordered by name; a key made for a branch lists that branch only.

Every call that is about one venue takes the venue's id from here in its path. More in Venues and branches.

Guide: Venues and branches

Parameters

Accept-LanguagestringHeader

The language of userMessage in an error: tr (the default), en, de, fr, it, es, ar or ru. The first language in the header decides, without its region (en-US reads as en) and without weighing q values; a language Cibusy does not offer is answered in Turkish. It does not choose the language of a menu: that is lang on the menu call.

Responses

200

The venues the key can read, its own first.

401

The X-Api-Key header is missing (PUBLIC_API_KEY_MISSING), or the key is invalid or has been revoked (PUBLIC_API_KEY_INVALID).

403

The key may not make this call (PUBLIC_API_SCOPE_MISSING). Every key made in the venue's panel may read venues, menus and tables.

429

The key's budget of about 120 requests a minute is spent; wait Retry-After seconds.

Retry-After

Seconds to wait. The next one-minute window opens within it.

The data of a successful answer: an array of these

A venue the API key can read, in the short form the list of venues uses.

idstring · uuid

The venue's id. Every call that is about one venue takes it in the path.

namestring

The venue's name as its guests know it.

usernamestringnullable

The username of the venue's page on Cibusy, the one in its menu link (cibusy.com/modakofte). null when the venue has not picked one.

typestring

Whether the venue is independent, a headquarter or a branch.

Independent
An independent venue: no branches, no headquarter.
Headquarter
A headquarter: its key reaches each of its active branches.
Branch
A branch: its key reaches this branch only, never its headquarter or another branch.
parentVenueIdstring · uuidnullable

The id of the headquarter a branch belongs to. null for every venue that is not a branch. A key made for a branch cannot read its headquarter, so the id is for telling a chain's venues apart, not for a call.