v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Lookup Relationships

Filter Definitions

Returns filter definitions based on the given target type. Target types include users (zen:user), tickets (zen:ticket), organizations (zen:organization), or custom objects (zen:custom_object:CUSTOM_OBJECT_KEY). The returned filter definitions are the options that you can use to build a custom field or ticket field's relationship_filter.

get/api/v2/relationships/definitions/{target_type}

Path parameters

target_typestring required

The target type for which you would like to see filter definitions. The options are "zen:user", "zen:ticket", "zen:organization", and "zen:custom_object:CUSTOM_OBJECT_KEY"

Query parameters

source_typestring

The source type for which you would like to see filter definitions. The options are "zen:user", "zen:ticket", and "zen:organization"

Response

Success response