Events API v2 - GET a event property

Gets the details about an event property.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}
  • SaaS https://{your-environment-id}{propertyKey}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}


To execute this request, you need the Read events ( permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
propertyKey string

The event property key you're inquiring.

path required


Response codes

Code Description


Response body

The EventPropertyDetail object

Configuration of an event property.

Element Type Description
key string

The event property key.

displayName string

The display name of the event property.

description string

A short description of the event property.

writable boolean

Indicates whether the property may be set during event ingestion.


In this example, the request queries the details of the Custom source event property.

The API token is passed in the Authorization header.


curl --request GET \
  --url '' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

Response body

  "key": "dt.event.source",
  "displayName": "Custom source",
  "description": "The name or ID of the external source of the event",
  "writable": true

Response code