Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountGroupKey AccountGroupKey Query-String Account group to get the events for.
    AccountKey AccountKey Query-String Account to get the events for.
    ClientKey ClientKey Query-String Client to get the events for.
    FieldGroups LookupFieldGroups Query-String Specify lookup fields required in response. If FieldGroups are not specified in request then response will only contain data from FieldGroups with relevant data.
    IncludeSubAccounts Bool Query-String Indicate whether to include events from sub-clients.
  • Response Parameters

    View Response Codes
    Name Type Description
    FieldGroup LookupFieldGroups Specifies the field for which lookup values are loaded in this lookup
    Values CodeDescription [] Lookup codes and names
  • Request Example

    Request URL
    GET ca/v2/events/lookupdata/?ClientKey=7m4I|vtYLUnEGg77o9uQhw==&AccountKey=2y0tX0m9ZH7MH8HK38qM9g==&AccountGroupKey=BxS0VWLta8lJ3SBpjGBQjw==&FieldGroups=All&IncludeSubAccounts=false
  • Response Example

    Response body
    {
      "Data": [
        {
          "FieldGroup": "EventTypes",
          "Values": [
            {
              "Code": "DVCA",
              "Name": "Cash Dividend"
            }
          ]
        },
        {
          "FieldGroup": "AssetTypes",
          "Values": [
            {
              "Code": "Stock",
              "Name": "Stock"
            }
          ]
        }
      ]
    }