Skip to navigation
API ReferenceDocuments

Get a users list of document for a given instrument

This endpoint retrieves a list of documents from a given instrument for a given user. The authenticated user must have access to the documents.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

clientAccountIdstringOptionalformat: "uuid"

The client-account identifier which represents the unique account of the user.

instrumentIdstringRequiredformat: "uuid"
Identifier for the documents instrument.
sortstringOptionalformat: "(created_at-asc|created_at-desc)"Defaults to created_at-asc
Optionally sort the results
limitstringOptionalformat: "uint64"Defaults to 20

Optionally limit the number of results (between 1 and 500)

querylist of stringsOptional
Optionally filter the results
cursorstringOptionalformat: "base64"
Optionally provide a cursor to paginate over pages of results
fieldslist of stringsOptional

Response

A successful response.
resultlist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error