Reference Data

Get reference dataset

get

Retrieves the reference dataset with the specified ID.

Path parameters

idintegerRequired

Reference dataset ID

Responses

200

Reference dataset retrieved

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/reference_data/{id}

HTTPcURLJavaScriptPython

GET /api/reference_data/{id} HTTP/1.1
Accept: */*

{
  "data": {
    "domain_ids": [
      101
    ],
    "headers": [
      "code",
      "name"
    ],
    "id": 321,
    "inserted_at": "2026-06-10T10:00:00Z",
    "name": "countries",
    "row_count": 249,
    "rows": [
      [
        "ES",
        "Spain"
      ],
      [
        "FR",
        "France"
      ],
      [
        "DE",
        "Germany"
      ]
    ],
    "updated_at": "2026-06-10T10:00:00Z"
  }
}

Update reference dataset

put

Updates the specified reference dataset with a new file, name, or domain assignments.

Path parameters

idintegerRequired

Reference dataset ID

Body

multipart/form-data

datasetstring · binary · nullableOptional

CSV file content

domain_idsinteger[] · nullableOptional

Domain IDs to associate with the dataset

namestring · nullableOptional

Dataset name

Responses

200

Reference dataset updated

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/api/reference_data/{id}

HTTPcURLJavaScriptPython

PUT /api/reference_data/{id} HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 100

{
  "dataset": "updated_reference_data.csv",
  "domain_ids": [
    1,
    3
  ],
  "name": "Updated Customer Status Dataset"
}

{
  "data": {
    "domain_ids": [
      101,
      102
    ],
    "id": 321,
    "name": "countries_updated",
    "row_count": 250
  }
}

Delete reference dataset

delete

Deletes the specified reference dataset.

Path parameters

idintegerRequired

Reference dataset ID

Responses

204

Reference dataset deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

delete/api/reference_data/{id}

HTTPcURLJavaScriptPython

DELETE /api/reference_data/{id} HTTP/1.1
Accept: */*

No content

Update reference dataset

patch

Updates the specified reference dataset with a new file, name, or domain assignments.

Path parameters

idintegerRequired

Reference dataset ID

Body

multipart/form-data

datasetstring · binary · nullableOptional

CSV file content

domain_idsinteger[] · nullableOptional

Domain IDs to associate with the dataset

namestring · nullableOptional

Dataset name

Responses

200

Reference dataset updated

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

patch/api/reference_data/{id}

HTTPcURLJavaScriptPython

PATCH /api/reference_data/{id} HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 100

{
  "dataset": "updated_reference_data.csv",
  "domain_ids": [
    1,
    3
  ],
  "name": "Updated Customer Status Dataset"
}

{
  "data": {
    "domain_ids": [
      101,
      102
    ],
    "id": 321,
    "name": "countries_updated",
    "row_count": 250
  }
}

List reference datasets

get

Returns reference datasets visible to the current user, filtered by permitted domain IDs.

Responses

200

Reference datasets retrieved

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/reference_data

HTTPcURLJavaScriptPython

GET /api/reference_data HTTP/1.1
Accept: */*

{
  "data": [
    {
      "domain_ids": [
        101
      ],
      "id": 321,
      "name": "countries",
      "row_count": 249
    },
    {
      "domain_ids": [
        101,
        102
      ],
      "id": 322,
      "name": "regions",
      "row_count": 50
    }
  ]
}

Create reference dataset

post

Creates a new reference dataset using uploaded data and associated metadata.

Body

multipart/form-data

datasetstring · binaryRequired

CSV file content

domain_idsinteger[]Required

Domain IDs to associate with the dataset

namestringRequired

Dataset name

Responses

201

Reference dataset created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/reference_data

HTTPcURLJavaScriptPython

POST /api/reference_data HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 84

{
  "dataset": "reference_data.csv",
  "domain_ids": [
    1,
    2
  ],
  "name": "Customer Status Dataset"
}

{
  "data": {
    "domain_ids": [
      101
    ],
    "id": 321,
    "name": "countries",
    "row_count": 249
  }
}

Download reference dataset as CSV

get

Downloads the specified reference dataset as a CSV attachment.

Path parameters

reference_data_idintegerRequired

Reference dataset ID

Responses

200

CSV file

text/csv

string · binaryOptional

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/reference_data/{reference_data_id}/csv

HTTPcURLJavaScriptPython

GET /api/reference_data/{reference_data_id}/csv HTTP/1.1
Accept: */*

binary