List dimension values

Changed on

List the values of one dimension, sorted by name. Values that are turned off are left out unless you pass includeDisabled=true.

get/v2/accounting/dimensions/{dimensionKey}/values

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/accounting/dimensions/{dimensionKey}/values
  • Auth
    API key in header X-API-Key

Query parameters

connectionIdstring

The accounting connection to read. Optional when the legal entity has exactly one connection; required (connection_id_required) when it has several. List them at GET /v2/accounting/connections.

cursorstring

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limitinteger

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

includeDisabledboolean

true returns disabled values alongside the enabled ones. Disabled values are left out by default.

parentValueIdstring

Return only values under this parent value (acc_dim_val_ prefix), for dimensions with a parentKey.

Response

A page of values.

Example response

{
  "items": [
    {
      "id": "accounting_account_2rj4l7hmrrrcv",
      "dimensionKey": "account",
      "connectionId": "accounting_connection_2rj4l7hmrrrcv",
      "name": "6100 Software Subscriptions",
      "externalId": "80",
      "platformStatus": "active",
      "parentId": "acc_dim_val_2rj4l7hmrrrcv"
    }
  ]
}

Changes