Skip to main content
GET
List branches

Authorizations

Authorization
string
header
required

Authorization: Basic base64(partner_key:secret_key).

Credentials are issued by a klikit operator. The plaintext secret_key is shown once at issuance and cannot be retrieved later — store it securely. If lost, ask your operator to rotate the secret to receive a new one. The old secret stops working immediately on rotation; there is no overlap window.

Query Parameters

page
integer
default:1

1-indexed page number. Echoed back in the response body.

Required range: x >= 1
size
integer
default:20

Items per page. Echoed back in the response body.

Required range: 1 <= x <= 100

Response

200 - application/json

Branch list

Canonical response wrapper. Every response — success or error — carries the request_id so you can quote one id to klikit support to correlate a request end-to-end.

request_id
string
required
Example:

"req_4d1b7e3f-..."

data
object

Paginated branch list payload. Note the items live under results (not branches).

error
object

Machine-readable error code + human message. The code is stable across releases — switch on code in your client code rather than parsing the message text.

Common codes you will encounter as a partner: