Account

The account, API client, plan, scopes and limits behind the credential that makes a request. Call GET /me first to confirm what your integration can do.

Endpoints

GET/me

The account context

Attributes

accountobjectRequired

Show 4 child attributesHide child attributes

idstring

namestring

typestring

Possible valuesbuyersupplierpartner

parent_idstringNullable

clientobjectRequired

Show 6 child attributesHide child attributes

idstring

namestring

environmentstring

Possible valueslivesandbox

key_prefixstring

ip_allowlistarray of string

branch_idsarray of stringNullable

IDs of the branches this client is limited to, or null when it can access every branch of the account.

scopesarray of stringRequired

planstringRequired

Possible valuesbasicproenterprisesupplier

featuresarray of stringRequired

Possible valuesbuyer_apiwebhookseventsbulk_exportip_allowlistmtlsaudit_api

rate_limitobjectRequired

Show 2 child attributesHide child attributes

per_minuteinteger

per_dayintegerNullable

api_versionstring

The account context

{
  "account": {
    "id": "72223",
    "name": "מאפייה אחת עשרה",
    "type": "supplier",
    "parent_id": null
  },
  "client": {
    "id": "cl_01J9KQ7X4M",
    "name": "ERP פריוריטי",
    "environment": "sandbox",
    "key_prefix": "zk_test_XXXXXXXX",
    "ip_allowlist": [
      "203.0.113.24/32"
    ],
    "branch_ids": null
  },
  "scopes": [
    "supplier.orders:read",
    "supplier.orders:write",
    "supplier.documents:read",
    "supplier.documents:write",
    "supplier.catalog:write",
    "supplier.buyers:read",
    "supplier.buyers:write",
    "events:read",
    "webhooks:manage"
  ],
  "plan": "supplier",
  "features": [
    "webhooks",
    "events",
    "ip_allowlist"
  ],
  "rate_limit": {
    "per_minute": 1200,
    "per_day": null
  },
  "api_version": "2"
}

Retrieve the authenticated client

GET/me

ScopeAny API key

Retrieve the account, account type, plan, effective scopes, branch restriction, rate limits and enabled features for the credential that makes the request. Make this the first call of every integration, and include its output when you contact support.

Responses

200The context of the authenticated client.

accountobjectRequired

Show 4 child attributesHide child attributes

idstring

namestring

typestring

Possible valuesbuyersupplierpartner

parent_idstringNullable

clientobjectRequired

Show 6 child attributesHide child attributes

idstring

namestring

environmentstring

Possible valueslivesandbox

key_prefixstring

ip_allowlistarray of string

branch_idsarray of stringNullable

IDs of the branches this client is limited to, or null when it can access every branch of the account.

scopesarray of stringRequired

planstringRequired

Possible valuesbasicproenterprisesupplier

featuresarray of stringRequired

Possible valuesbuyer_apiwebhookseventsbulk_exportip_allowlistmtlsaudit_api

rate_limitobjectRequired

Show 2 child attributesHide child attributes

per_minuteinteger

per_dayintegerNullable

api_versionstring

401The API key or token is missing, invalid, expired or revoked. The code is unauthorized, key_expired or key_revoked.

Headers: X-Request-Id

429The rate limit was exceeded. Retry after the number of seconds given in Retry-After.

Headers: Retry-After RateLimit-Limit RateLimit-Remaining RateLimit-Reset

GET /me

curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/me" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"

const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/me", {
  method: "GET",
  headers: {
    Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
  },
});
const data = await res.json();

import requests

res = requests.get(
    "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/me",
    headers={
        "Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
    },
)
data = res.json()

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var res = await http.GetAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/me");
var data = await res.Content.ReadAsStringAsync();

Response

{
  "account": {
    "id": "72223",
    "name": "מאפייה אחת עשרה",
    "type": "supplier",
    "parent_id": null
  },
  "client": {
    "id": "cl_01J9KQ7X4M",
    "name": "ERP פריוריטי",
    "environment": "sandbox",
    "key_prefix": "zk_test_XXXXXXXX",
    "ip_allowlist": [
      "203.0.113.24/32"
    ],
    "branch_ids": null
  },
  "scopes": [
    "supplier.orders:read",
    "supplier.orders:write",
    "supplier.documents:read",
    "supplier.documents:write",
    "supplier.catalog:write",
    "supplier.buyers:read",
    "supplier.buyers:write",
    "events:read",
    "webhooks:manage"
  ],
  "plan": "supplier",
  "features": [
    "webhooks",
    "events",
    "ip_allowlist"
  ],
  "rate_limit": {
    "per_minute": 1200,
    "per_day": null
  },
  "api_version": "2"
}

{
  "type": "https://developers.zester.co.il/errors/unauthorized",
  "title": "Missing or invalid credential",
  "status": 401,
  "code": "unauthorized",
  "detail": "The Authorization header is missing. Send \"Authorization: Bearer <API key or access token>\".",
  "instance": "/v2/me",
  "request_id": "req_01J9KQ9E4H"
}

{
  "type": "https://developers.zester.co.il/errors/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "Client cl_01J9KQ7X4M exceeded 1200 requests per minute. Retry after 14 seconds.",
  "instance": "/v2/me",
  "request_id": "req_01J9KQ9F6J"
}