GET /api/v2/custom_objects/{custom_object_key}/records/autocomplete
Retrieves an array of custom object records that have a field value that matches the value specified in the name parameter.
Pagination
- Cursor pagination only.
- Returns the first 10,000 records sorted by relevancy with page limits.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_key |
String | Yes |
The key of a custom object |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
source |
String | No |
One of "zen:user", "zen:ticket", "zen:organization", or "zen:custom_object:CUSTOM_OBJECT_KEY". Represents the object |
requester_id |
Integer | No |
The id of the requester. For use with dynamic filters. |
name |
String | No |
Part of a name of the record you are searching for |
assignee_id |
Integer | No |
The id of the selected assignee. For use with dynamic filters. |
field_id |
String | No |
The id of the lookup field. If the field has a relationship filter, the filter is applied to the results. Must be used with |
pageafter |
String | No |
A pagination cursor that tells the endpoint which page to start on. It should be a |
pagebefore |
String | No |
A pagination cursor that tells the endpoint which page to start on. It should be a |
organization_id |
Integer | No |
The id of the organization the requester belongs to. For use with dynamic filters. |
pagesize |
Integer | No |
The number of records to return in the response. You can specify up to 100 records per page. |
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.