List Pockets For Customers

Request

Retrieve all Pockets for a list of Customers.

Security

HTTPBearer

Query

omit[]Array of strings or null(Omit[])

Any of:

unique

Array of strings

cursorstring or null(Cursor)

Any of:

string

limitinteger, [ 0 .. 30 ](Limit)

Default:30

valuation_typeValuationType (string) or null(Valuation Type)

Any of:

string(ValuationType)

Enum:"rfq""jikonet"

filter[status]Array of strings, unique(Filter[Status])

Default:["PENDING","OPEN","FROZEN"]

Items Enum:"PENDING""OPEN""FROZEN""CLOSED"

x-jiko-idempotencystring, (uuid)(X-Jiko-Idempotency)required

A UUID you generate to identify this request. Reusing a value that was already sent is rejected as a duplicate request.

x-jiko-signaturestring(X-Jiko-Signature)required

Base64-encoded HMAC-SHA256 hash of x-jiko-idempotency + request pathname + body, keyed with your shared secret. See Authentication for the full algorithm and a code sample.

curl -i -X GET \
  'https://your-partner-name.sandbox-api.jikoservices.com/api/v2/pockets/?omit%5B%5D=portfolio&cursor=string&limit=30&valuation_type=rfq&filter%5Bstatus%5D=PENDING%2COPEN%2CFROZEN' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json

prev_pagestring or null(Prev Page)

Any of:

string

next_pagestring or null(Next Page)

Any of:

string

itemsArray of objects(Items)required

object_typestring(Object Type)

Default:"CursorList"

Response

{
  "next_page": "cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw",
  "items": [
    { … }
  ],
  "object_type": "CursorList"
}