Query custom event definitions
GET {{baseUrl}}/events/v3/event-definitions?searchString=<string>&after=<string>&limit=<integer>&includeProperties=<boolean>&sortOrder=<string>
Search for existing custom event definitions.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
searchString | string | Characters in the event name that the user is searching for. This search is a naive “contains” search, no fuzzy matching is done. | |
after | string | The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results. | |
limit | string | The maximum number of results to display per page. | |
includeProperties | string | ||
sortOrder | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"archived":"\u003cboolean\u003e","associations":[{"allowsCustomLabels":"\u003cboolean\u003e","cardinality":"ONE_TO_ONE","category":"USER_DEFINED","fromObjectTypeId":"\u003cstring\u003e","hasAllAssociatedObjects":"\u003cboolean\u003e","hasCascadingDeletes":"\u003cboolean\u003e","hasUserEnforcedMaxFromObjectIds":"\u003cboolean\u003e","hasUserEnforcedMaxToObjectIds":"\u003cboolean\u003e","hidden":"\u003cboolean\u003e","id":"\u003cinteger\u003e","inverseAllowsCustomLabels":"\u003cboolean\u003e","inverseCardinality":"ONE_TO_ONE","inverseHasAllAssociatedObjects":"\u003cboolean\u003e","inverseId":"\u003cinteger\u003e","inverseName":"\u003cstring\u003e","isInversePrimary":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","maxFromObjectIds":"\u003cinteger\u003e","maxToObjectIds":"\u003cinteger\u003e","name":"\u003cstring\u003e","portalUniqueIdentifier":"\u003cstring\u003e","toObjectTypeId":"\u003cstring\u003e","inverseLabel":"\u003cstring\u003e","fromObjectType":"AD_CAMPAIGN","toObjectType":"TEMPLATE","label":"\u003cstring\u003e"},{"allowsCustomLabels":"\u003cboolean\u003e","cardinality":"ONE_TO_MANY","category":"HUBSPOT_DEFINED","fromObjectTypeId":"\u003cstring\u003e","hasAllAssociatedObjects":"\u003cboolean\u003e","hasCascadingDeletes":"\u003cboolean\u003e","hasUserEnforcedMaxFromObjectIds":"\u003cboolean\u003e","hasUserEnforcedMaxToObjectIds":"\u003cboolean\u003e","hidden":"\u003cboolean\u003e","id":"\u003cinteger\u003e","inverseAllowsCustomLabels":"\u003cboolean\u003e","inverseCardinality":"ONE_TO_MANY","inverseHasAllAssociatedObjects":"\u003cboolean\u003e","inverseId":"\u003cinteger\u003e","inverseName":"\u003cstring\u003e","isInversePrimary":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","maxFromObjectIds":"\u003cinteger\u003e","maxToObjectIds":"\u003cinteger\u003e","name":"\u003cstring\u003e","portalUniqueIdentifier":"\u003cstring\u003e","toObjectTypeId":"\u003cstring\u003e","inverseLabel":"\u003cstring\u003e","fromObjectType":"AD","toObjectType":"SOCIAL_PROFILE","label":"\u003cstring\u003e"}],"fullyQualifiedName":"\u003cstring\u003e","id":"\u003cstring\u003e","labels":{"singular":"\u003cstring\u003e","plural":"\u003cstring\u003e"},"name":"\u003cstring\u003e","objectTypeId":"\u003cstring\u003e","properties":[{"description":"\u003cstring\u003e","fieldType":"\u003cstring\u003e","groupName":"\u003cstring\u003e","label":"\u003cstring\u003e","name":"\u003cstring\u003e","options":[{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"},{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e","createdUserId":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","modificationMetadata":{"archivable":"\u003cboolean\u003e","readOnlyDefinition":"\u003cboolean\u003e","readOnlyValue":"\u003cboolean\u003e","readOnlyOptions":"\u003cboolean\u003e"},"displayOrder":"\u003cinteger\u003e","showCurrencySymbol":"\u003cboolean\u003e","hubspotDefined":"\u003cboolean\u003e","formField":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","archivedAt":"\u003cdateTime\u003e","archived":"\u003cboolean\u003e","referencedObjectType":"\u003cstring\u003e","calculationFormula":"\u003cstring\u003e","hasUniqueValue":"\u003cboolean\u003e","updatedUserId":"\u003cstring\u003e","calculated":"\u003cboolean\u003e","externalOptions":"\u003cboolean\u003e","updatedAt":"\u003cdateTime\u003e"},{"description":"\u003cstring\u003e","fieldType":"\u003cstring\u003e","groupName":"\u003cstring\u003e","label":"\u003cstring\u003e","name":"\u003cstring\u003e","options":[{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"},{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e","createdUserId":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","modificationMetadata":{"archivable":"\u003cboolean\u003e","readOnlyDefinition":"\u003cboolean\u003e","readOnlyValue":"\u003cboolean\u003e","readOnlyOptions":"\u003cboolean\u003e"},"displayOrder":"\u003cinteger\u003e","showCurrencySymbol":"\u003cboolean\u003e","hubspotDefined":"\u003cboolean\u003e","formField":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","archivedAt":"\u003cdateTime\u003e","archived":"\u003cboolean\u003e","referencedObjectType":"\u003cstring\u003e","calculationFormula":"\u003cstring\u003e","hasUniqueValue":"\u003cboolean\u003e","updatedUserId":"\u003cstring\u003e","calculated":"\u003cboolean\u003e","externalOptions":"\u003cboolean\u003e","updatedAt":"\u003cdateTime\u003e"}],"createdUserId":"\u003cinteger\u003e","trackingType":"VISITED_URL","description":"\u003cstring\u003e","primaryObjectId":"\u003cstring\u003e","primaryObject":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e"},{"archived":"\u003cboolean\u003e","associations":[{"allowsCustomLabels":"\u003cboolean\u003e","cardinality":"ONE_TO_MANY","category":"USER_DEFINED","fromObjectTypeId":"\u003cstring\u003e","hasAllAssociatedObjects":"\u003cboolean\u003e","hasCascadingDeletes":"\u003cboolean\u003e","hasUserEnforcedMaxFromObjectIds":"\u003cboolean\u003e","hasUserEnforcedMaxToObjectIds":"\u003cboolean\u003e","hidden":"\u003cboolean\u003e","id":"\u003cinteger\u003e","inverseAllowsCustomLabels":"\u003cboolean\u003e","inverseCardinality":"ONE_TO_MANY","inverseHasAllAssociatedObjects":"\u003cboolean\u003e","inverseId":"\u003cinteger\u003e","inverseName":"\u003cstring\u003e","isInversePrimary":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","maxFromObjectIds":"\u003cinteger\u003e","maxToObjectIds":"\u003cinteger\u003e","name":"\u003cstring\u003e","portalUniqueIdentifier":"\u003cstring\u003e","toObjectTypeId":"\u003cstring\u003e","inverseLabel":"\u003cstring\u003e","fromObjectType":"CAMPAIGN_TEMPLATE","toObjectType":"SITE_PAGE","label":"\u003cstring\u003e"},{"allowsCustomLabels":"\u003cboolean\u003e","cardinality":"ONE_TO_ONE","category":"USER_DEFINED","fromObjectTypeId":"\u003cstring\u003e","hasAllAssociatedObjects":"\u003cboolean\u003e","hasCascadingDeletes":"\u003cboolean\u003e","hasUserEnforcedMaxFromObjectIds":"\u003cboolean\u003e","hasUserEnforcedMaxToObjectIds":"\u003cboolean\u003e","hidden":"\u003cboolean\u003e","id":"\u003cinteger\u003e","inverseAllowsCustomLabels":"\u003cboolean\u003e","inverseCardinality":"ONE_TO_MANY","inverseHasAllAssociatedObjects":"\u003cboolean\u003e","inverseId":"\u003cinteger\u003e","inverseName":"\u003cstring\u003e","isInversePrimary":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","maxFromObjectIds":"\u003cinteger\u003e","maxToObjectIds":"\u003cinteger\u003e","name":"\u003cstring\u003e","portalUniqueIdentifier":"\u003cstring\u003e","toObjectTypeId":"\u003cstring\u003e","inverseLabel":"\u003cstring\u003e","fromObjectType":"PLAYLIST","toObjectType":"SOCIAL_PROFILE","label":"\u003cstring\u003e"}],"fullyQualifiedName":"\u003cstring\u003e","id":"\u003cstring\u003e","labels":{"singular":"\u003cstring\u003e","plural":"\u003cstring\u003e"},"name":"\u003cstring\u003e","objectTypeId":"\u003cstring\u003e","properties":[{"description":"\u003cstring\u003e","fieldType":"\u003cstring\u003e","groupName":"\u003cstring\u003e","label":"\u003cstring\u003e","name":"\u003cstring\u003e","options":[{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"},{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e","createdUserId":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","modificationMetadata":{"archivable":"\u003cboolean\u003e","readOnlyDefinition":"\u003cboolean\u003e","readOnlyValue":"\u003cboolean\u003e","readOnlyOptions":"\u003cboolean\u003e"},"displayOrder":"\u003cinteger\u003e","showCurrencySymbol":"\u003cboolean\u003e","hubspotDefined":"\u003cboolean\u003e","formField":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","archivedAt":"\u003cdateTime\u003e","archived":"\u003cboolean\u003e","referencedObjectType":"\u003cstring\u003e","calculationFormula":"\u003cstring\u003e","hasUniqueValue":"\u003cboolean\u003e","updatedUserId":"\u003cstring\u003e","calculated":"\u003cboolean\u003e","externalOptions":"\u003cboolean\u003e","updatedAt":"\u003cdateTime\u003e"},{"description":"\u003cstring\u003e","fieldType":"\u003cstring\u003e","groupName":"\u003cstring\u003e","label":"\u003cstring\u003e","name":"\u003cstring\u003e","options":[{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"},{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e","createdUserId":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","modificationMetadata":{"archivable":"\u003cboolean\u003e","readOnlyDefinition":"\u003cboolean\u003e","readOnlyValue":"\u003cboolean\u003e","readOnlyOptions":"\u003cboolean\u003e"},"displayOrder":"\u003cinteger\u003e","showCurrencySymbol":"\u003cboolean\u003e","hubspotDefined":"\u003cboolean\u003e","formField":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","archivedAt":"\u003cdateTime\u003e","archived":"\u003cboolean\u003e","referencedObjectType":"\u003cstring\u003e","calculationFormula":"\u003cstring\u003e","hasUniqueValue":"\u003cboolean\u003e","updatedUserId":"\u003cstring\u003e","calculated":"\u003cboolean\u003e","externalOptions":"\u003cboolean\u003e","updatedAt":"\u003cdateTime\u003e"}],"createdUserId":"\u003cinteger\u003e","trackingType":"VISITED_URL","description":"\u003cstring\u003e","primaryObjectId":"\u003cstring\u003e","primaryObject":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e"}],"total":"\u003cinteger\u003e","paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}