API References
Start typing to search…

List partner allocations and deallocations

get
https://app.bitgo-test.com/api/network/v1/enterprises//partners/allocations

Lists all allocations and deallocations. For use only by OES partners.

Path Params
string
required
length ≥ 1
Query Params
allocationIds
array of strings

Optional array of allocationIds. allocationIds are unique identifiers (UUIDs) for allocations. If UUIDs are provided, only allocations/deallocations with those UUIDs are returned. UUIDs must be submitted as a comma-separated string.

allocationIds
types
array of strings

Optional array of types. If types are provided, only allocations/deallocations with those types are returned. Types must be submitted as a comma-separated string. allocation = records for allocations to connections. deallocation = records for deallocations from connections.

types
statuses
array of strings

Optional array of statuses. If statuses are provided, only allocations/deallocations with those statuses are returned. Statuses must be submitted as a comma-separated string. cleared = records for allocations that have been cleared. released = records for allocations that have been released. reserved = records for allocations that are still reserved.

statuses
currencies
array of strings

Optional array of partner mapped currencies. If currencies are provided, only allocations/deallocations with those currencies are returned. Currencies must be submitted as a comma-separated string.

currencies
connectionIds
array of strings

Optional array of connectionIds. If connectionIds are provided, only allocations/deallocations for those connectionIds are returned. ConnectionIds must be submitted as a comma-separated string.

connectionIds
partnerIds
array of strings

Optional array of partnerIds. If partnerIds are provided, only allocations/deallocations for those partnerIds are returned. PartnerIds must be submitted as a comma-separated string.

partnerIds
clientIds
array of strings

Optional array of clientIds. If clientIds are provided, only allocations/deallocations for those clientIds are returned. ClientIds must be submitted as a comma-separated string.

clientIds
string

The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.

string

The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.

string
enum

The field to sort results on.

Possible values:

  • id: Sort by allocation ID.
  • updatedAt: Sort by the last updated timestamp.
  • quantity: Sort by the allocation amount quantity.

Note: A final sort is always applied on createdAt ascending and id ascending, regardless of the specified sortField. This ensures consistent ordering for items with the same primary sort value.

Allowed:
string
enum

The direction to sort results.

Possible values:

  • ASC: Ascending order (lowest to highest, A to Z, oldest to newest)
  • DESC: Descending order (highest to lowest, Z to A, newest to oldest)

If not specified, defaults to ASC (ascending).

Allowed:
Responses

Updated 29 days ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 29 days ago