---
title: "Get a reference dataset"
method: GET
path: "/{sub_domain}/api/reference-data/{dataset_name}"
tags: ["Reference-Data"]
---

# Get a reference dataset

`GET /{sub_domain}/api/reference-data/{dataset_name}`

## Request

- Base URL: `https://api.commpeak.com/pbx`
- URL: `https://api.commpeak.com/pbx/{sub_domain}/api/reference-data/{dataset_name}`
- Auth: API key in header `Authorization`

Returns a single reference dataset by name, so you can map the codes that appear in call data to human-readable labels in your own reporting and UI.

**When to use.** Look up the fixed lookup values used across call data, for example to turn a Q.850 cause code or a SIP response code into a readable label, to list the possible call statuses, or to map a country id to its ISO code and name. These values change rarely, so you can fetch them once and cache them.

**Parameters.** `dataset-name` (path, required) selects which dataset to return. Allowed values:

- `object-types`: call object type ID to its meaning.
- `status`: the possible call status values.
- `q850`: Q.850 disconnect cause code to its meaning.
- `client-hangup-dispositions`: the possible values identifying who ended the call.
- `sip-term-statuses`: SIP termination response code to its reason phrase.
- `countries`: country ISO 3166-1 alpha-2 code to an object with the country `id` and `name`. Use it to resolve the country ids returned elsewhere in the API.

**Returns.** A single-key object whose key is the requested `dataset-name` and whose value is that dataset: a map of code to label, a flat list of string values, or for `countries` a map of ISO code to an object with `id` and `name`. An unknown dataset name returns `404`.

**Example.** `GET /api/reference-data/q850`

## Path parameters

- `dataset_name` 'object-types' | 'status' | 'q850' | 'client-hangup-dispositions' | 'sip-term-statuses' | 'countries', required: The name of the dataset to retrieve.
- `sub_domain` string, required: PBX Name (subdomain)

## Response `200`

Successful Response

- ReferenceDataResponse: Single reference dataset keyed by its dataset name. Exactly one property is present, matching the requested dataset-name. Same as dialer, except `object-types` omits the Campaign Leads, Progressive and Predictive call types.
  - `object-types` object, nullable: Call object type ID to its meaning.
  - `status` string[], nullable: Possible call status values.
  - `q850` object, nullable: Q.850 disconnect cause code to its meaning.
  - `client-hangup-dispositions` string[], nullable: Possible values identifying who ended the call.
  - `sip-term-statuses` object, nullable: SIP termination response code to its reason phrase.
  - `countries` object, nullable: Country ISO 3166-1 alpha-2 code to the country id and name. The id is the value used wherever the API refers to a country by id.

## Other responses

- `404`: Not Found
- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-pbx-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-pbx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-pbx-api/revisions/0b1e8c7fd3f6?raw)