List series

List all registered series with the AT for the supplier.

GET /apps/at-pt/v1/entry/{silo_entry_id}/series

cURL

cURL

curl --request GET \
  --url https://api.invopop.com/apps/at-pt/v1/entry/{silo_entry_id}/series \
  --header 'Authorization: Bearer <token>'

200

{
  "limit": 20,
  "list": [
    {
      "id": "1d8ab49a-bd14-11ef-925f-325096b39f47",
      "code": "FT SERIES-A",
      "base": "SERIES-A",
      "document_type": "FT",
      "type": "N",
      "validation_code": "AAJFJ3N5YS"
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiMTIzNCIsImxpbWl0IjoyMH0="
}

This enpoints provides a way to list all registered series with the AT for the supplier with cursor-based pagination.

Authorizations

Authorization · string · header · required

Use the Bearer scheme with a valid JWT token to authenticate requests.

Example: Authorization: Bearer <token>

Path Parameters

silo_entry_id · string · required

Silo entry ID of the supplier to list series for.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

Query Parameters

cursor · string

The position marker from the previous result's next_cursor property, used for pagination.

Example:

"eyJsYXN0X2lkIjoiMTIzNCIsImxpbWl0IjoyMH0="

limit · integer · default: 100

The maximum number of entries to return in a single page of results.

Required range: 1 <= x <= 100

Example:

20

Response

200

application/json

Paginated list of series.

limit · integer

Maximum number of entries in this page.

Example:

20

list · List · object[]

List of series for this page.

Show child attributes

next_cursor · string

Cursor used to identify the next page of results. Omitted when there are no more results.

Example:

"eyJsYXN0X2lkIjoiMTIzNCIsImxpbWl0IjoyMH0="