Skip to main content
GET
List Requests
Returns a paginated list of service requests that belong to the authenticated broker. The full endpoint is GET /api/v1/requests. The request does not have a body.

Filtering And Order

The API applies all specified filters before it applies offset and limit. It sorts matching requests by submitted_date in descending order. The date boundaries are inclusive. You can use a date, such as 2026-05-01, or a timestamp, such as 2026-05-31T23:59:59Z. The pagination.page value is floor(offset / limit) + 1. Use an offset that is a multiple of limit when you need predictable page numbers.

Errors

Error responses use success: false and an error object.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
status
enum<string>
Available options:
pending,
approved,
denied
type
enum<string>
Available options:
new-service,
upgrade,
downgrade,
cancellation,
cancellation-warning,
revert,
welcome-email
source
enum<string>
Available options:
manual,
form,
api

Case-insensitive client name/email search or exact public request ID.

submitted_after
string

Inclusive date or timestamp parseable by JavaScript Date.parse; ISO 8601 is recommended.

submitted_before
string

Inclusive date or timestamp parseable by JavaScript Date.parse; ISO 8601 is recommended.

include_custom_data
boolean
default:false

Only the literal value true includes sanitized public custom data.

Response

Paginated request list.

success
boolean
required
pagination
object
required
data
object[]
required
message
string
Last modified on August 2, 2026