Make your first request

Obtain access

Ask the CRM profile owner to issue an integration API key with clients.read. Confirm which API environment and release are available to you. A key is limited to one profile; an employee account cannot manage integration keys.

Keep the key in your application's secret store. The owner receives its raw value only once. Read the key lifecycle guide before distributing or rotating a key.

Read clients

The server selected for this documentation build is https://open-api.beautybox-stage.ru/api. Use it only after the owner confirms access. Read requests can return real profile data.

# Set these in your local environment; never commit a real API key.
export TETRADKA_API_BASE='https://open-api.beautybox-stage.ru/api'
read -r -s TETRADKA_API_KEY
export TETRADKA_API_KEY

curl --get "$TETRADKA_API_BASE/open/crm/v1/clients" \
  -H "X-Api-Key: $TETRADKA_API_KEY" \
  -H 'Accept: application/json' \
  -H 'X-Locale: en' \
  --data-urlencode 'skip=0' \
  --data-urlencode 'take=15'

The response is an object with count and clients. An empty result is:

{"count":0,"clients":[]}

count is the matching total before pagination. Follow the pagination guide to read another page.

Explore the reference

Open the API reference, choose Authorize and enter your own key. Expand GET /open/crm/v1/clients, select Try it out, then Execute. Clear optional example filters you do not need. In particular, use either phone or phoneExact, never both. Authorization is not saved across browser sessions. Only execute requests for which the owner has granted access; write operations change real data.

A 401 means the key is missing or cannot authenticate. A 403 means a required scope is missing. See permissions and errors and retries before adding write operations.