---
title: "Event Custom Fields"
method: GET
path: "/v1/references/event_custom_fields"
tags: ["References"]
---

# Event Custom Fields

`GET /v1/references/event_custom_fields`

## Request

- Base URL: `https://api.exhibitday.com`
- URL: `https://api.exhibitday.com/v1/references/event_custom_fields`
- Auth: one of:
  - API key in header `api_key`
  - API key in query parameter `api_key`

Returns a list of available custom event fields (custom fields that have been added to events) in your ExhibitDay workspace. Note: whenever you retrieve an event, the values for all of its custom fields are listed in the custom_fields property of the event (pass hydrate_custom_fields=true to include them). The list also contains layout items (labels and dividers) whose field_type is empty; they hold no value.

Documentation: https://api.exhibitday.com/Help/V1?epf=3#get-v1-references-event_custom_fields

## Headers

- `If-None-Match` string

## Response `200`

OK

- EventCustomFieldsList, nullable
  - `records_found` integer
  - `list_type` string, nullable
  - `list_data` WorkspaceCustomEventFieldSetting[], nullable
    - `field_name` string, nullable
    - `event_tab` string, nullable
    - `field_type` string, nullable
    - `field_label` string, nullable
    - `is_hidden` boolean

## Other responses

- `304`: Not Modified: If-None-Match named the current ETag, so there is no body.
- `400`: Bad Request: a missing or invalid parameter, or a change that is not allowed (error_code says which).
- `401`: Unauthorized: the api_key is missing or invalid, or API access is not enabled for the workspace.
- `404`: Not Found: no object with that id in your workspace, or an unknown URL or method.
- `429`: Too Many Requests: the rate limit was exceeded.
- `500`: Unexpected Internal Error.

---

[API](https://skmtc.dev/exhibitday/apis/exhibitday-api.md) · [All operations](https://skmtc.dev/exhibitday/apis/exhibitday-api/llms.txt) · [OpenAPI document](https://skmtc.dev/exhibitday/apis/exhibitday-api/revisions/a35e95422b0a?raw)