The code a new sheet of a type would probably get

GET

/api/v1/sheets/next-code

curl --request GET \
  --url 'https://example.com/api/v1/sheets/next-code?type=example' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

Authorizations

• APIKeyHeader

Parameters

Query Parameters

type

required

Type

Sheet type key.

string

<= 64 characters

Sheet type key.

Responses

200

Successful Response

Media typeapplication/json

NextCode

object

code

required

Code

string

hint

required

Hint

A hint, not a reservation (spec 10.1).

string

Allowed value: probable

Example

{
  "hint": "probable"
}

404

Sheet type not found.

Media typeapplication/json

object

detail

required

object

error_code

required

string

error_detail

Any of:

object

object

key

additional properties

any

null

null

error_message

required

string

Example ^generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}

422

Validation Error

Media typeapplication/json

object

detail

required

object

error_code

required

string

error_detail

Any of:

object

object

key

additional properties

any

null

null

error_message

required

string

Example ^generated

{
  "detail": {
    "error_code": "example",
    "error_detail": {},
    "error_message": "example"
  }
}