Skip to main content
GET
List Label Requests

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://oauth.loopreturns.com/authorize
Token URL
https://oauth.loopreturns.com/oauth/token
Scopes1
label_requests:read
Read access to label requests

Query Parameters

from
string<date-time>

Returns label requests after or equal to a minimum date. A date-time value in ISO 8601 format. What it represents (for example, when a label, label request, or reported error was created, or a date-range filter bound) depends on the field or parameter referencing this schema.

Example:

"2023-04-25T13:25:00-05:00"

to
string<date-time>

Returns label requests before a maximum date. A date-time value in ISO 8601 format. What it represents (for example, when a label, label request, or reported error was created, or a date-range filter bound) depends on the field or parameter referencing this schema.

Example:

"2023-04-25T13:25:00-05:00"

return_id
integer

Return label requests associated with a specific return_id.

Example:

67329889100573

status
enum<string>

The status of the label request.

Available options:
issued,
cancelled,
fulfilled
Example:

"issued"

limit
integer
default:50

The per page limit of label requests to return

Required range: 0 <= x <= 250
offset
integer

The number of label requests to offset.

Required range: x >= 0

Response

Success

data
object[]