v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Custom Object Records

Autocomplete Custom Object Record Search

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
get/api/v2/custom_objects/{custom_object_key}/records/autocomplete

Path parameters

custom_object_keystring required

The key of a custom object

Query parameters

namestring

Part of a name of the record you are searching for

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

field_idstring

The id of the lookup field. If the field has a relationship filter, the filter is applied to the results. Must be used with source param.

sourcestring

One of "zen:user", "zen:ticket", "zen:organization", or "zen:custom_object:CUSTOM_OBJECT_KEY". Represents the object field_id belongs to. Must be used with field_id param.

requester_idinteger

The id of the requester. For use with dynamic filters.

assignee_idinteger

The id of the selected assignee. For use with dynamic filters.

organization_idinteger

The id of the organization the requester belongs to. For use with dynamic filters.

Response

Success response

countinteger

The number of results returned for the current request