Get Requests

Allowed Scopes: experimental:request:read
Returns card, purchase order, invoice, credit note, travel and claim requests for the authenticated company. Only these request types are listed: single_purchase, subscription, subscription_increase, multi_use_card, multi_use_card_top_up, multi_use_card_end_date_change, card_load, purchase_order, invoice, credit_note, travel_budget, travel_booking, expense, mileage_allowance and per_diem_allowance. subscription_increase, purchase_order, invoice, credit_note, travel_budget and travel_booking requests are returned only when type is set to that type, as their amount is the new budget of a subscription, a commitment to a supplier, a supplier document or a trip, not card spend. purchase_order requests also need the experimental:purchase-order:read scope, and invoice and credit_note requests the experimental:invoice:read scope: without it, none are returned. Claims (expense, mileage_allowance and per_diem_allowance) are returned only to companies with the claims feature enabled, and asking only for claims without it answers 403. Drafts, incomplete and paid claims are never returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number

integer
1 to 30
Defaults to 30

Page size

string
enum

Filter by request type. Without it, every listed type except subscription_increase, purchase_order, invoice, credit_note, travel_budget and travel_booking is returned.

string
enum

Filter by request state.

boolean

Filters claims (expense, mileage_allowance, per_diem_allowance) only, so combine it with a claim type: other types never match it. true keeps the claims a controller reviewed, false the others. The claims feature is required.

string

Filter by requester user ID.

string

Filter by supplier ID.

date
^\d{4}-\d{2}-\d{2}$

Return requests created on or after this date (YYYY-MM-DD, UTC).

date
^\d{4}-\d{2}-\d{2}$

Return requests created on or before this date (YYYY-MM-DD, UTC).

number

Filter by minimum requested amount, in major units. Compared against the request's amount converted to the company's functional currency using stored exchange rates.

number

Filter by maximum requested amount, in major units. Compared against the request's amount converted to the company's functional currency using stored exchange rates.

boolean
Defaults to false

Include the approval object on each returned request. Off by default because resolving the approval chain costs an extra lookup per page.

Headers
string

ID of the company the request acts on. Required with an organisation-level token; not needed with a company-level token.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json