List Client Allocations and Deallocations

get/api/network/v1/enterprises/{enterpriseId}/clients/allocations

This API call allows clients to get a list of allocations & deallocations for any connected network account. Note that this endpoint requires a “types” query parameter set to “allocation” to view allocations or "deallocation" to view deallocations.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Query Parameters

  • allocationIdsarray[string]
  • typesarray[string]
    Enum: allocation deallocation
  • statusesarray[string]
    Enum: cleared released reserved
  • currenciesarray[string]
  • connectionIdsarray[string]
  • partnerIdsarray[string]
  • createdOnOrAfterstring<date-time>
  • createdBeforestring<date-time>
  • pageNumberstring<integer>
  • pageSizestring
  • sortFieldstring
    Enum: id updatedAt quantity currency
  • sortDirectionstring
    Enum: ASC DESC

200 Response

allocations array[object] required
id string required
amountOne ofrequired
connectionId string required
clientExternalId string required
Min length: >= 1 characters
partnerExternalId string
Min length: >= 1 characters
initiatedBy string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required
retriable boolean required
reason
string or null
required
Min length: >= 1 characters
status string required
Allowed values: cleared released reserved
type string required
Allowed values: allocation deallocation

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required