---
title: "List Custom Event Schemas"
method: GET
path: "/management/v1/projects/{projectId}/custom-event-schemas"
tags: ["Management"]
---

# List Custom Event Schemas

`GET /management/v1/projects/{projectId}/custom-event-schemas`

Lists all custom event schemas available in the project.

> 📘 Custom Event Documentation
>
> Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify.
>
>Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).

## Response `200`

Returns the details about the custom event schemas created in the project.

- ManagementProjectsCustomEventSchemasListResponseBody — Object containing a list of custom event schemas.
  - `object` 'list', required — The type of the object represented by JSON. This object stores information about the custom event schemas in a dictionary.
  - `data_ref` 'data', required — Identifies the name of the attribute that contains the array of custom event schema objects.
  - `data` ManagementProjectsCustomEventSchema[], required — Array of custom event schema objects.
    - `id` string, required — Unique identifier of the custom event schema.
    - `name` string, required — User-defined name of the custom event. This is also shown in **Project Settings** > **Event Schema** in the Voucherify Dashboard.
    - `schema` object, required — Object containing custom event schema and its custom attributes (metadata).
      - `properties` object, required — Defines custom event custom attributes (metadata).
    - `created_at` string, date-time, required — Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format.
    - `updated_at` string, date-time — Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format.
    - `object` 'custom-event-schema', required — The type of the object represented by JSON.
  - `total` integer, required — The total number of custom event schema objects.

## Other responses

- `401` — Returns an error if an invalid token was provided.
- `402` — Returns an error if the current plan does not include the Management API feature.
- `404` — Returns an error when a resource could not be found.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/revisions/4982266e0494/schema)