---
title: "Get registries"
method: GET
path: "/registry"
tags: ["Registers"]
---

# Get registries

`GET /registry`

The method allows the user to get information about their registries or registries related to their profile in the registry.

🔸Registries are automatically filtered by creation source (`clientapi` or `bc`) depending on the method used.</br>
🔸Shipments that were removed from the registry are not included in the response.

## Query parameters

- `isEURegistry` boolean
- `ids[]` string[]
- `numbers[]` string[]
- `settlementIds[]` string[]
- `withShipmentsInfo` boolean
- `createdAtFrom` string, date
- `createdAtTo` string, date
- `page` integer
- `limit` integer

## Response `200`

Registries list

- object
  - `current_page` integer — Indicates the current page number in the paginated response.
  - `last_page` integer — Total number of available pages calculated.
  - `per_page` integer — Number of registry records returned per page.
  - `total` integer — Total number of registries that match the request criteria.
  - `items` object[] — Array of registry objects. Each registry aggregates shipments and related metadata.
    - `id` string — Unique identifier of the registry generated by the system.
    - `number` string — Registry number in the format: CR + country code + unique numeric identifier.
    - `createdAt` string, date-time — Date and time when the registry was created.
    - `updatedAt` string, date-time — Date and time of the last registry update.
    - `deletedAt` string, date-time — Date and time when the registry was deleted, if applicable.
    - `posted` boolean — Indicates whether the registry has been posted (processed). - `true` — registry is processed - `false` — registry is not processed
    - `printed` boolean — Indicates whether the registry has been printed.
    - `description` string — User-defined name of the registry.
    - `status` string — Current registry status.
    - `type` 'Client' — Registry type. When created via API, the value is always `Client`.
    - `createdByUser` string — Identifier of the user who created the registry.
    - `scannedBarcodesAmount` integer — Number of shipments included in the registry.
    - `source` string — Source of registry creation (for example, `clientapi`).
    - `companyId` string — Company identification number.
    - `companyTin` string — Company tax identification number.
    - `companyName` string — Company name.
    - `fullName` string — Full sender name from the first shipment in the registry.
    - `phone` string — Sender phone number from the first shipment.
    - `countryCode` string — ISO 3166-1 alpha-2 country code of the sender.
    - `country` string — Country of the sender.
    - `settlementId` string — Sender settlement identifier.
    - `settlementName` string — Sender settlement name.
    - `divisionId` string — Sender division identifier.
    - `divisionName` string — Sender division name.
    - `address` string — Full sender address in text format.
    - `addressParts` object — Structured address object containing detailed address information. Used for accurate routing, pickup, delivery, and customs processing.
      - `city` string — City name.
      - `region` string — Region, province, or administrative area.
      - `street` string — Street name.
      - `streetId` string — Unique street identifier.
      - `postCode` string — Postal or ZIP code.
      - `building` string — Building number or name.
      - `flat` string — Apartment or unit number.
      - `block` string — Block or section of the building.
      - `latitude` number — Geographic latitude coordinate.
      - `longitude` number — Geographic longitude coordinate.
      - `note` string — Additional address details or instructions.
      - `addressId` string — Unique address identifier in the system.
    - `currencyCode` string — Currency code.
    - `shipments` object[] — Array of shipment objects included in the registry. Returned when `withShipmentsInfo` is omitted or set to `false`.
      - `shipmentId` string — Unique shipment identifier.
      - `shipmentNumber` string — Shipment number.
    - `shipmentsInfo` object[] — Array of shipment objects included in the registry. Returned when `withShipmentsInfo=true`.
      - `id` string — Shipment identifier.
      - `number` string — Shipment number.
      - `totalWeight` integer — Total shipment weight in grams.
      - `totalCost` number — Total shipment value.
      - `currencyCode` string — Shipment currency code.
      - `invoice` boolean — Indicates whether an invoice exists.

## Other responses

- `401` — Unauthorized
- `404` — The specified resource was not found
- `422` — Validation error
- `503` — Connection time-out

---

[API](https://skmtc.net/novapost/apis/api-nova-post.md) · [All operations](https://skmtc.net/novapost/apis/api-nova-post/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/novapost/api-nova-post/revisions/60e380005037/schema)