--- title: "Get notes" method: GET path: "/ats/notes" tags: ["Unified ATS API"] --- # Get notes `GET /ats/notes` Retrieve all notes. Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)` ## Query parameters - `cursor` string — An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. - `page_size` integer — The number of results to return per page. Maximum is 250. - `updated_after` string, date-time — Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `author` | ✗ No | ✗ No | | `application` | ✗ No | ✗ No | | `candidate` | ✗ No | ✗ No | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ - `include_deleted` 'true' | 'false' — By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. - `ignore_unsupported_filters` 'true' | 'false' — When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. - `ids` string — Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. - `remote_ids` string — Filter by a comma-separated list of remote IDs. - `candidate_ids` string — Filter by a comma-separated list of candidate IDs. Prefer filtering by `candidate_ids` when you want to download the full context available for a candidate, across all their applications. - `application_ids` string — Filter by a comma-separated list of application IDs. Use filtering by `application_ids` only if you want the context available for specific applications. Results do not include notes that only link to the candidate, but not the application. ## Headers - `X-Integration-Id` string, required ## Response `200` GET /ats/notes Positive response - GetAtsNotesPositiveResponse - `status` 'success', required - `data` object, required - `next` string, nullable, required — Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages. - `results` object[], required - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. - `remote_id` string, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. - `candidate_id` string, required — The Kombo ID of the candidate this note is about. The ID can be used to retrieve the candidate from the `get candidates` endpoint. - `application_id` string, nullable, required — The Kombo ID of the application this note is about, when the note is tied to a specific application. Some systems attach notes to the candidate only, in which case this is `null`. - `author_id` string, nullable, required — The Kombo ID of the user who authored the note. `null` for notes generated by the system rather than a specific user. The ID can be used to retrieve the user from the `get users` endpoint. - `title` string, nullable, required — The note title from the ATS. - `content_html` string, nullable, required — The note content from the ATS, passed through as-is. This may contain HTML markup when the source ATS stores it that way. - `is_private` boolean, nullable, required — Whether the note requires elevated permissions to access in the source ATS (e.g. a `private`, `secret`, or `admin only` flag), meaning it is not visible to everyone with standard access to the candidate/application. `null` when the source ATS does not expose such a signal. - `remote_created_at` string, date-time, nullable, required — The date and time the object was created in the remote system. - `remote_updated_at` string, date-time, nullable, required — A timestamp retrieved from the remote system, describing when the resource was last updated. - `remote_data` object, nullable, required — Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. - `changed_at` string, date-time, required — The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated. - `remote_deleted_at` string, date-time, nullable, required — The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear. - `author` object, nullable, required - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. - `remote_id` string, nullable, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. - `first_name` string, nullable, required — First name of the user. - `last_name` string, nullable, required — Last name of the user. - `email` string, nullable — Email of the user. If the email address is invalid, it will be set to null. ## Other responses - `default` — The standard error response with the error codes for the ATS use case. --- [API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/1e45035b96d3/schema)