List Custom Event Schemas

Lists all custom event schemas available in the project.

📘 Custom Event Documentation

Read Custom Events article to learn how custom events work in Voucherify.

Read also the details about the Track Custom Event endpoint and the Custom Event Object.

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

List Custom Event Schemas

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/custom-event-schemas \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>'

200

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "ms_t4ir0Dcu5T0m3v3nT5ch3ma",
      "name": "newsletter_subscribed",
      "schema": {
        "properties": {}
      },
      "created_at": "2023-08-03T10:37:48.716Z",
      "object": "custom-event-schema"
    },
    {
      "id": "ms_s3c0N6cu5T0m3v3nT5ch3ma",
      "name": "review_left",
      "schema": {
        "properties": {}
      },
      "created_at": "2023-08-03T10:37:48.710Z",
      "updated_at": "2024-04-26T14:35:03.463Z",
      "object": "custom-event-schema"
    },
    {
      "id": "ms_f1r5Tcu5T0m3v3nT5ch3ma",
      "name": "sign_up",
      "schema": {
        "properties": {}
      },
      "created_at": "2023-08-03T10:37:48.705Z",
      "object": "custom-event-schema"
    }
  ],
  "total": 3
}

{
  "code": 401,
  "message": "Unauthorized",
  "key": "unauthorized"
}

{
  "code": 402,
  "message": "Payment required",
  "details": "Your current plan does not include a feature required to perform this operation.",
  "key": "missing_required_feature"
}

{
  "code": 404,
  "message": "Resource not found",
  "details": "Cannot find project with id proj_5itvDU7"
}

Authorizations

X-Management-Id · string · header · required

X-Management-Token · string · header · required

Path Parameters

projectId · string · required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

Response

200

application/json

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

Object containing a list of custom event schemas.

object · enum<string> · default: list · required

The type of the object represented by JSON. This object stores information about the custom event schemas in a dictionary.

Available options: list

data_ref · enum<string> · default: data · required

Identifies the name of the attribute that contains the array of custom event schema objects.

Available options: data

data · Management Projects Custom Event Schema · object[] · required

Array of custom event schema objects.

Show child attributes

total · integer · required

The total number of custom event schema objects.