Search Disbursements

get

https://api.branchapp.com/v2/organizations/{orgId}/disbursements

Searches all disbursements.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

int32

required

Organization ID

Query Params

status

string

enum

The disbursement's status

type

string

enum

The disbursement's type

external_id

string

The disbursement's external ID

invoice_id

int64

The disbursement's invoice ID

worker_id

string

The disbursement's worker ID

time_last_attempted_start

date-time

The start of the timeframe to search for disbursement attempts

time_last_attempted_end

date-time

The end of the timeframe to search for disbursement attempts

worker_group

string

The disbursement's worker group

after

string

Cursor to retrieve size elements after. Use the value from next_cursor to get the next page. Formatted as a Base64-encoded JSON object containing the element ID.

before

string

Cursor to retrieve size elements before. Use the value from prev_cursor to get the previous page. Formatted as a Base64-encoded JSON object containing the element ID.

size

int64

Number of elements on the page

sort

string

Format: field_name,direction

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK