Retrieve a paginated list of dimensions | Ottimate Developer Documentation

curl -G https://api.ottimate.com/v1/dimensions \
     -H "X-Api-Key: your-api-key-here" \
     -H "X-API-Version: 1.0.0" \
     -H "Authorization: Bearer <token>" \
     -d ottimate_company_id=15196 \
     -d erp_type=Account \
     -d page=1 \
     -d limit=20

{
  "version": "1.0.0",
  "count": 100,
  "page": 1,
  "limit": 20,
  "dimensions": [
    {
      "id": "dim_VOH21Up3M7HV",
      "name": "Food Cost",
      "erp_type": "Account",
      "erp_dimension_id": "5000",
      "code": "5000",
      "reference_id": "acct-food-cost-001",
      "ottimate_type": "account",
      "ottimate_company_id": 15196
    },
    {
      "id": "dim_XKL45Qp8N2RT",
      "name": "Beverage Cost",
      "erp_type": "Account",
      "erp_dimension_id": "5100",
      "code": "5100",
      "reference_id": "acct-beverage-cost-001",
      "ottimate_type": "account",
      "ottimate_company_id": 15196
    },
    {
      "id": "dim_MNO78Ts4P6YZ",
      "name": "Kitchen Department",
      "erp_type": "Department",
      "erp_dimension_id": "DEPT-001",
      "code": "DEPT-001",
      "reference_id": "dept-kitchen-001",
      "ottimate_type": "department",
      "ottimate_company_id": 15196
    }
  ]
}

Returns a paginated list of dimensions, filterable by company and type. The detail=basic query parameter returns a simplified response with only id, name, erp_dimension_id, and erp_type per item (omitting code, reference_id, ottimate_type, and ottimate_company_id).

Authentication

AuthorizationBearer

OAuth2 authentication flows. Auth server URLs will vary by environment

Query parameters

ottimate_company_idintegerOptional

Filter dimensions by company ID

erp_typestringOptional

Filter dimensions by ERP type

detailenumOptional

Specify the level of detail in the response. When set to basic, each item in dimensions is reduced to id, name, erp_dimension_id, and erp_type — code, reference_id, ottimate_type, and ottimate_company_id are dropped. Omit this parameter for the full object.

Allowed values:

pageintegerOptionalDefaults to 1

Page number (default 1)

limitintegerOptionalDefaults to 20

Number of results per page (default 20)

Response

Successful response with paginated dimension list

versionstring

countinteger

pageinteger

limitinteger

dimensionslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Headers

Query parameters

Response

Errors