Skip to main content
A partner credential is bound to one business and granted a subset of scopes. The endpoint you call must be covered by at least one scope on your credential, or the response is 403 FORBIDDEN_SCOPE.

Scope catalogue

ScopeEndpoints it unlocks
brands:readGET /brands, GET /branches
menus:readGET /menus (store-level and business-level)
menus:oosPATCH /items/{partner_item_id}/availability, bulk OOS updates
orders:readGET /orders, GET /orders/{id}
visibility:writeBranch and brand visibility toggles
webhooks:readRead your registered webhook URLs (operator-driven today)

Asking for more scopes

Scope changes are made by your klikit operator. Send the list of scopes you need and the business id to [email protected] and we’ll widen the credential. No code change on your side — the next request after the update reflects the new permissions.