Skip to main content
GET
/
v1
/
team
/
encodings
Get encodings
curl --request GET \
  --url https://api.oneofnone.io/v1/team/encodings \
  --header 'x-api-key: <api-key>'
[
  {
    "id": 123,
    "ref": "<string>",
    "status": "DRAFT",
    "quantity": 123,
    "encoded_at": "2023-11-07T05:31:56Z",
    "requested_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Response

Successfully retrieved encodings.

​
id
integer

Unique identifier for the encoding.

​
ref
string

Human-readable reference code for the encoding.

​
status
enum<string>

Current status of the encoding job.

Available options:
DRAFT,
REQUESTED,
PENDING_URLS,
URLS_GENERATED,
ENCODING,
ENCODED,
SHIPPED,
DELIVERED,
COMPLETED,
CANCELED
​
quantity
integer | null

Number of NFC tags in this encoding batch.

​
encoded_at
string<date-time> | null

When the encoding was performed.

​
requested_at
string<date-time> | null

When the encoding was requested.

​
completed_at
string<date-time> | null

When the encoding job was completed.

​
created_at
string<date-time>

When the encoding record was created.

​
updated_at
string<date-time> | null

When the encoding was last updated.