Invopop home pagelight logo
  1. Series
  2. Fetch a Series
GET

/sequence/v1/series/{id}

Bearer*
curl --request GET \
     --url https://api.invopop.com/sequence/v1/series/{id} \
     --header 'Authorization: Bearer AUTH_VALUE'
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2023-01-25T08:04:14.245Z",
  "updated_at": "2023-01-25T08:04:14.245Z",
  "name": "string",
  "description": "string",
  "code": "string",
  "prefix": "string",
  "padding": 0,
  "suffix": "string",
  "last_index": 0,
  "last_entry_id": "string",
  "sigs": [
    "string"
  ]
}

​
Parameters

idRequired
string

Series id

​
Response

id
string

UUID that uniquely identifies the series.

created_at
string
updated_at
string
name
string

Human reference for the series.

description
string

Optional details about this series.

code
string

Optional fixed code that will be set alongside the generated number.

prefix
string

Text to insert at start of generated codes.

padding
integer

Minimum length of a code's number part, padded with 0s.

suffix
string

Text to insert after the number in generated codes.

last_index
integer

The last number used in the series.

last_entry_id
string

Last inserted Entry UUID

sigs
string[]

JSON Web Signatures generated when the series was created.