Skip to content
LabelyardLabelyardLabelyard

List sheets

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
type
Type

Sheet type key.

Any of:
string
<= 64 characters

Sheet type key.

free_at_least
Free At Least
Any of:
integer
<= 400
state
State
string
default: active
Allowed values: active full discarded all
q
Q

Part of the code.

Any of:
string
<= 24 characters

Part of the code.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Sheets Api V1 Sheets Get
Array<object>
SheetSummary
object
code
required
Code
string
free
required
Free
integer
label_h
required
Label H
number
label_w
required
Label W
number
last_used_at
required
Last Used At
Any of:
string
reserved
required
Reserved
integer
state
required
State
string
Allowed values: active discarded
total
required
Total
integer
type_key
required
Type Key
string
type_label
required
Type Label
string
unconfirmed
required
Unconfirmed
integer
used
required
Used
integer
version
required
Version
integer

Example 

[
  {
    "state": "active"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
object
detail
required
object
error_code
required
string
error_detail
Any of:
object
key
additional properties
any
error_message
required
string

Example generated

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