CLclear-street
Omni AI

Get Entitlements

Changed on

List caller's active entitlement grants.

Deprecated -- use GET /omni-ai/entitlement-status; this lists explicit grants only and omits accounts that are enabled by default.

get/v1/omni-ai/entitlements

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Query parameters

account_idinteger

Response

Caller's active entitlement grants

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes

  • 1bd9eddeffc8Revision changes
    • info

      endpoint deprecated

  • ae04ae681b64Revision changes
    • breaking

      removed the required property /// from the response with the status

    • warning

      deleted the query request parameter trading_account_id

    • info

      added the new optional query request parameter account_id

    • info

      added the required property /// to the response with the status