Skip to main content
GET
List allocations

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Query Parameters

membersUuids
string[]

Filter allocations by member identifiers.

capacityUuid
string<uuid> | null

Filter allocations by capacity identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
territoryUuid
string<uuid>

Filter allocations by territory identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
limit
string

Maximum number of allocations to return.

offset
string

Number of allocations to skip.

Response

List allocations

allocations
Allocations · object[]
required

List of allocations.