Skip to content

Correct the ticket search fields, sorting and page size #748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yasser-aboelgheit-intercom merged 2 commits into from
Oct 21, 2026
Merged

Correct the ticket search fields, sorting and page size #748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
018b188
Correct the ticket search fields, sorting and page size
yasser-aboelgheit-intercom Oct 21, 2026
d20d061
Exclude title and description from ticket search sort fields
yasser-aboelgheit-intercom Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27528,7 +27528,7 @@ paths:
{% admonition type="warning" name="Optimizing search queries" %}
Search queries can be complex, so optimizing them can help the performance of your search.
Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize
pagination to limit the number of results returned. The default is `20` results per page.
pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.
See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.
{% /admonition %}

Expand All @@ -27542,19 +27542,18 @@ paths:
### Accepted Fields

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`).
The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result.
Fields not in the table below, such as `source.body`, are rejected with a `400` error.

| Field | Type |
| :---------------------------------------- | :--------------------------------------------------------------------------------------- |
| id | String |
| id | Integer |
| created_at | Date (Unix timestamp in seconds) |
| updated_at | Date (Unix timestamp in seconds) |
| title | String |
| description | String |
| category | String |
| ticket_type_id | String |
| ticket_type_id | Integer |
| contact_ids | String |
| teammate_ids | String |
| admin_assignee_id | Integer |
| team_assignee_id | Integer |
| open | Boolean |
Expand All @@ -27569,6 +27568,10 @@ paths:
* For **Tracker** category tickets, use the term `tracker`.
{% /admonition %}

### Sorting

You can sort the results with a `sort` object, for example `{"field": "created_at", "order": "ascending"}`. `field` must be one of the fields in the table above, other than `ticket_attribute.{id}`, `title` and `description`. `order` is `ascending` or `descending`, and any other value is treated as `descending`. Without `sort`, results are sorted by `updated_at`, newest first.

### Accepted Operators

{% admonition type="info" name="Searching based on `created_at`" %}
Expand Down
17 changes: 10 additions & 7 deletions descriptions/2.17/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24564,7 +24564,7 @@ paths:
{% admonition type="warning" name="Optimizing search queries" %}
Search queries can be complex, so optimizing them can help the performance of your search.
Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize
pagination to limit the number of results returned. The default is `20` results per page.
pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.
See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.
{% /admonition %}

Expand All @@ -24578,21 +24578,20 @@ paths:
### Accepted Fields

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`).
The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result.
Fields not in the table below, such as `source.body`, are rejected with a `400` error.

| Field | Type |
| :---------------------------------------- | :--------------------------------------------------------------------------------------- |
| id | String |
| id | Integer |
| created_at | Date (UNIX timestamp) |
| updated_at | Date (UNIX timestamp) |
| title | String |
| description | String |
| category | String |
| ticket_type_id | String |
| ticket_type_id | Integer |
| contact_ids | String |
| teammate_ids | String |
| admin_assignee_id | String |
| team_assignee_id | String |
| admin_assignee_id | Integer |
| team_assignee_id | Integer |
| open | Boolean |
| state | String |
| snoozed_until | Date (UNIX timestamp) |
Expand All @@ -24605,6 +24604,10 @@ paths:
* For **Tracker** category tickets, use the term `tracker`.
{% /admonition %}

### Sorting

You can sort the results with a `sort` object, for example `{"field": "created_at", "order": "ascending"}`. `field` must be one of the fields in the table above, other than `ticket_attribute.{id}`, `title` and `description`. `order` is `ascending` or `descending`, and any other value is treated as `descending`. Without `sort`, results are sorted by `updated_at`, newest first.

### Accepted Operators

{% admonition type="info" name="Searching based on `created_at`" %}
Expand Down
Loading