Sign in
Exports

Export Disbursements

Exports a CSV file of disbursements.

get/exports/disbursements

Query parameters

qstring

A search term used to query through the disbursement names.

status'DRAFT' | 'READY' | 'STARTED' | 'PAUSED' | 'COMPLETED' | 'CANCELED'

Comma-separated list of disbursement statuses to filter by.

created_at_afterstring

Only return disbursements that are created after this date. Format: YYYY-MM-DD

created_at_beforestring

Only return disbursements that are created before this date. Format: YYYY-MM-DD

sort'name' | 'created_at'

Field used to sort disbursements

direction'asc' | 'desc'

Direction for sorting disbursements.

Headers

X-Wallet-Idstring

Optional. Narrows the results to a single distribution account. Omit it to cover every account you have access to.

Response

CSV file of disbursements

Changes

Changed in 3 of the 12 revisions of this API.33

  • 7588d8d2a3c72See the full diff
    • ○

      added the new optional header request parameter X-Wallet-Id

      new-optional-request-parameter

    • ○

      added the new enum value CANCELED to the query request parameter status

      request-parameter-enum-value-added

  • b6f8a6e655593See the full diff
    • ▲

      for the query request parameter direction, default value was changed from asc to desc

      request-parameter-default-value-changed

    • ▲

      removed the media type */* for the response with the status 401

      response-media-type-removed

    • ▲

      removed the media type */* for the response with the status 403

      response-media-type-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dc42844e575d1See the full diff
    • ○

      endpoint added

      endpoint-added