List Inquiry Requests

List inquiries for your account or other resources.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns inquiries newest first, scoped to your API key's organisation and environment. Empty filters are ignored.

Use account_id to include both account inquiries and shared person inquiries relevant to the account. A result can have account_id: null; use its id for subsequent operations.

Response

data contains inquiry objects. Pagination meta contains page, per_page, count_total, page_total, prev_page, and next_page. Continue while next_page is true.

FieldMeaning
idStable inquiry ID.
typestandard for information; link for a hosted action.
queryUser instruction; may be null.
statusInquiry state. A submitted standard response can remain pending.
linkHosted URL; may be null after expiry or completion.
object_type, causeRelated object type and reason.
person_id, business_id, account_id, deposit_id, payout_id, conversion_id, card_idRelated IDs; unused fields are null.
is_deleted, created_at, updated_atRecord metadata; updated_at may be null.
StatusMeaning
200Results returned, including an empty list.
401Invalid credentials or insufficient authorization.
500Unable to retrieve inquiries.

See RFI handling and Inquiry Events. Example IDs and URLs are placeholders.

Query Params
string

Includes account inquiries and shared person inquiries relevant to this account.

int32
Defaults to 1

Page number; starts at 1.

int32
Defaults to 20

Results per page. Default 20; maximum 200. Invalid or nonpositive values use 20.

string

Filter by person ID.

string

Filter by inquiry type, such as standard or link.

string

Filter by inquiry status, such as pending, completed, or cancelled.

string

Filter by inquiry cause.

string

Filter by the associated object type.

string

Filter by business ID.

string

Filter by deposit ID.

string

Filter by payout ID.

string

Filter by card ID.

string

Filter by conversion ID.

string

Search inquiry IDs, causes, related IDs, and question text.

Responses

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