GET /api/v2/{target_type}/{target_id}/relationship_fields/{field_id}/{source_type}
Returns a list of source objects whose values are populated with the id of a related target object. For example,
if you have a lookup field called "Success Manager" on a ticket, this endpoint can answer the question,
"What tickets (sources) is this user (found by target_type and target_id)
assigned as the 'Success Manager' (field referenced by field_id)?"
This endpoint also resolves multi-lookup fields.
Pass the multi-lookup field's id as field_id and "zen:ticket" as source_type to list the tickets that
reference a target record through the field. Multi-lookup reverse lookups are resolved through search, so tickets
the requesting agent can't view are excluded.
Allowed For
- Agents
Pagination
- Cursor pagination (recommended)
- Offset pagination
For a multi-lookup field_id, only cursor pagination applies. Offset pagination parameters are ignored and the
response uses cursor pagination.
See Pagination.
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
field_id |
Integer | Yes |
The id of the lookup relationship field |
source_type |
String | Yes |
The type of object the relationship field belongs to (example. ticket field belongs to a ticket object). The options are "zen:user", "zen:ticket", "zen:organization", and "zen:custom_object:CUSTOM_OBJECT_KEY" |
target_type |
String | Yes |
The type of object the relationship field is targeting. The options are "zen:user", "zen:ticket", "zen:organization", and "zen:custom_object:CUSTOM_OBJECT_KEY" |
target_id |
Integer | Yes |
The id of the object the relationship field is targeting |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.