Get Custom item list

Description

This service retrieves the list of available options for a custom list, which can be used to populate a single or multi-select dropdown menu in a user interface.

---

Request

Endpoint

GET https://<server-url>/api/v3/referencedata/customitemlist/{item_list_id}

Path Parameters

Parameter	Type	Description
item_list_id	Integer	The unique ID of the custom item list to retrieve.

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API. Use Thalamus-Token for the header.

Full URL Example

https://<server-url>/api/v3/referencedata/customitemlist/123?touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON array of strings is returned, where each string is an available option in the list.

JSON

[
  "item_one",
  "item_two",
  "item_three"
]

❌ Unsuccessful Response: 400 Bad Request

Returned if the provided item_list_id is invalid or does not exist.

JSON

{
  "errors": {
    "itemList": "InvalidID"
  }
}