---
title: "Получить определения пользовательских регистров"
method: GET
path: "/api/v1/core/registers"
tags: ["Core registers"]
---

# Получить определения пользовательских регистров

`GET /api/v1/core/registers`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/core/registers`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)
  - HTTP bearer

Страница определений, сначала системные, затем по имени и ключу. Отбор сужается параметрами q, module и kind. Ответ называет применённые limit и offset: страница ровно в limit строк означает, что дальше может быть ещё, — запрашивайте следующую с offset += limit. Служебные регистры других модулей исключаются до среза страницы, поэтому короткая страница означает конец списка, а не скрытые строки.

## Query parameters

- `q` string
- `module` string
- `kind` 'balance' | 'turnover' | 'info'
- `limit` integer
- `offset` integer

## Headers

- `X-Tenant` string, required

## Response `200`

Определения регистров

- CoreRegisterPage
  - `count` integer, required
  - `limit` integer, required: Применённый размер страницы — после зажима до потолка
  - `offset` integer, required: Применённое смещение
  - `results` CoreRegister[], required
    - `id` string, uuid, required
    - `key` string, required
    - `name` string, required
    - `kind` 'balance' | 'turnover' | 'info', required
    - `module` string, required
    - `is_system` boolean, required
    - `dimensions` CoreRegisterDimension[], required
      - `key` string, required
      - `ref` string, required
      - `name` string
      - `required` boolean
    - `resources` CoreRegisterResource[], required
      - `key` string, required
      - `type` 'numeric' | 'money', required
      - `unit` string
      - `name` string
      - `label_key` string: Optional translation key for a system resource label.
      - `balanced` boolean
      - `posts_to_ledger` boolean
      - `ledger_account_dim` string
      - `ledger_counter_dim` string
      - `ledger_account_by_value` object
      - `ledger_liability_values` string[]
    - `has_entries` boolean, required
    - `entry_count` integer, required
    - `last_entry_at` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Некорректный запрос или нарушение бизнес-правила
- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/3c60ded179f2?raw)