> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Get notes
> Retrieve all notes.
This feature is currently available for the following integrations:
You'd like to see this feature for another integration? Please reach out!
We're always happy to discuss extending our coverage.
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)`
## OpenAPI
````yaml GET /ats/notes
openapi: 3.1.0
info:
title: Kombo API
version: 1.0.0
servers:
- url: https://api.kombo.dev/v1
description: Kombo EU API
- url: https://api.us.kombo.dev/v1
description: Kombo US API
security:
- ApiKey: []
tags:
- name: General
- name: Kombo Connect
description: >-
Endpoints for Kombo Connect, our end-user-facing flow for setting up new
integrations.
- name: Unified HRIS API
description: Unified endpoints to access all the HR concepts you might need.
- name: Unified ATS API
description: Unified endpoints to access all the ATS concepts you might need.
- name: Unified ATS (Assessment & Background Check) API
description: >-
Unified endpoints to operate Assessments and Background Checks for many
applicant tracking systems.
- name: Unified LMS API
description: Unified endpoints to access all the LMS concepts you might need.
- name: AI Apply
description: Endpoints for AI-powered job application features.
- name: Custom Endpoints
description: Custom integration-specific endpoints.
paths:
/ats/notes:
get:
tags:
- Unified ATS API
summary: Get notes
description: >-
Retrieve all notes.
This feature is currently available for the following integrations:
You'd like to see this feature for another integration? Please reach
out!
We're always happy to discuss extending our coverage.
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)`
operationId: GetAtsNotes
parameters:
- in: header
name: X-Integration-Id
schema:
type: string
description: ID of the integration you want to interact with.
example: join:HWUTwvyx2wLoSUHphiWVrp28
required: true
- name: cursor
in: query
required: false
description: >-
An optional cursor string used for pagination. This can be retrieved
from the `next` property of the previous page response.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterCursor'
- name: page_size
in: query
required: false
description: The number of results to return per page. Maximum is 250.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterPageSize'
- name: updated_after
in: query
required: false
description: >-
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._
schema:
$ref: '#/components/schemas/GetAtsNotesParameterUpdatedAfter'
- name: include_deleted
in: query
required: false
description: >-
By default, deleted entries are not returned. Use the
`include_deleted` query param to include deleted entries too.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterIncludeDeleted'
- name: ignore_unsupported_filters
in: query
required: false
description: >-
When set to `true`, filters targeting fields not supported by this
integration will be ignored instead of filtering out all results.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterIgnoreUnsupportedFilters'
- name: ids
in: query
required: false
description: >-
Filter by a comma-separated list of IDs such as
`222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterIds'
- name: remote_ids
in: query
required: false
description: Filter by a comma-separated list of remote IDs.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterRemoteIds'
- name: candidate_ids
in: query
required: false
description: >-
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.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterCandidateIds'
- name: application_ids
in: query
required: false
description: >-
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.
schema:
$ref: '#/components/schemas/GetAtsNotesParameterApplicationIds'
responses:
'200':
description: GET /ats/notes Positive response
content:
application/json:
schema:
$ref: '#/components/schemas/GetAtsNotesPositiveResponse'
examples:
example1:
value:
status: success
data:
next: >-
eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=
results:
- id: H77fDF8uvEzGNPRubiz5DvQ7
remote_id: '32'
candidate_id: 26vafvWSRmbhNcxJYqjCzuJg
application_id: H5daSm8e85Dmvmne3wLeCPhX
author_id: 5J7L4b48wBfffYwek9Az9pkM
title: Screening call
content_html: >-
Available from March, looking for a hybrid role in
Berlin.
is_private: true
remote_created_at: '2022-08-07T14:01:29.196Z'
remote_updated_at: '2022-08-07T14:01:29.196Z'
remote_data: null
changed_at: '2022-08-07T14:01:29.196Z'
remote_deleted_at: null
author:
id: 26vafvWSRmbhNcxJYqjCzuJg
remote_id: '32'
first_name: John
last_name: Doe
email: john.doe@kombo.dev
default:
$ref: '#/components/responses/ErrorResponseATS'
components:
schemas:
GetAtsNotesParameterCursor:
type: string
description: >-
An optional cursor string used for pagination. This can be retrieved
from the `next` property of the previous page response.
GetAtsNotesParameterPageSize:
type: integer
format: int64
minimum: 1
maximum: 250
default: 100
description: The number of results to return per page. Maximum is 250.
GetAtsNotesParameterUpdatedAfter:
description: >-
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._
type: string
format: date-time
pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
GetAtsNotesParameterIncludeDeleted:
type: string
enum:
- 'true'
- 'false'
default: 'false'
description: >-
By default, deleted entries are not returned. Use the `include_deleted`
query param to include deleted entries too.
GetAtsNotesParameterIgnoreUnsupportedFilters:
type: string
enum:
- 'true'
- 'false'
default: 'false'
description: >-
When set to `true`, filters targeting fields not supported by this
integration will be ignored instead of filtering out all results.
GetAtsNotesParameterIds:
type: string
description: >-
Filter by a comma-separated list of IDs such as
`222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
GetAtsNotesParameterRemoteIds:
type: string
description: Filter by a comma-separated list of remote IDs.
GetAtsNotesParameterCandidateIds:
type: string
description: >-
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.
GetAtsNotesParameterApplicationIds:
type: string
description: >-
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.
GetAtsNotesPositiveResponse:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
next:
type:
- string
- 'null'
description: >-
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:
type: array
items:
type: object
properties:
id:
type: string
description: >-
The globally unique ID of this object generated by Kombo.
We recommend using this as a stable primary key for
syncing.
remote_id:
type: string
description: >-
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:
type: string
description: >-
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:
type:
- string
- 'null'
description: >-
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:
type:
- string
- 'null'
description: >-
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:
type:
- string
- 'null'
description: The note title from the ATS.
content_html:
type:
- string
- 'null'
description: >-
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:
type:
- boolean
- 'null'
description: >-
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:
description: >-
The date and time the object was created in the remote
system.
type:
- string
- 'null'
format: date-time
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
remote_updated_at:
description: >-
A timestamp retrieved from the remote system, describing
when the resource was last updated.
type:
- string
- 'null'
format: date-time
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
remote_data:
type:
- object
- 'null'
additionalProperties: true
description: >-
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:
description: >-
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.
type: string
format: date-time
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
remote_deleted_at:
description: >-
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.
type:
- string
- 'null'
format: date-time
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
author:
type:
- object
- 'null'
properties:
id:
type: string
description: >-
The globally unique ID of this object generated by
Kombo. We recommend using this as a stable primary key
for syncing.
remote_id:
type:
- string
- 'null'
description: >-
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:
type:
- string
- 'null'
description: First name of the user.
last_name:
type:
- string
- 'null'
description: Last name of the user.
email:
type:
- string
- 'null'
pattern: >-
^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$
description: >-
Email of the user. If the email address is invalid, it
will be set to null.
required:
- id
- remote_id
- first_name
- last_name
examples:
- id: 26vafvWSRmbhNcxJYqjCzuJg
remote_id: '32'
first_name: John
last_name: Doe
email: john.doe@kombo.dev
required:
- id
- remote_id
- candidate_id
- application_id
- author_id
- title
- content_html
- is_private
- remote_created_at
- remote_updated_at
- remote_data
- changed_at
- remote_deleted_at
- author
required:
- next
- results
examples:
- next: >-
eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=
results:
- id: H77fDF8uvEzGNPRubiz5DvQ7
remote_id: '32'
candidate_id: 26vafvWSRmbhNcxJYqjCzuJg
application_id: H5daSm8e85Dmvmne3wLeCPhX
author_id: 5J7L4b48wBfffYwek9Az9pkM
title: Screening call
content_html: Available from March, looking for a hybrid role in Berlin.
is_private: true
remote_created_at: '2022-08-07T14:01:29.196Z'
remote_updated_at: '2022-08-07T14:01:29.196Z'
remote_data: null
changed_at: '2022-08-07T14:01:29.196Z'
remote_deleted_at: null
author:
id: 26vafvWSRmbhNcxJYqjCzuJg
remote_id: '32'
first_name: John
last_name: Doe
email: john.doe@kombo.dev
required:
- status
- data
responses:
ErrorResponseATS:
description: The standard error response with the error codes for the ATS use case.
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- error
error:
type: object
properties:
code:
type:
- string
- 'null'
enum:
- PLATFORM.RATE_LIMIT_EXCEEDED
- PLATFORM.CONCURRENCY_LIMIT_EXCEEDED
- PLATFORM.INTEGRATION_NOT_FOUND
- PLATFORM.INPUT_INVALID
- PLATFORM.UNKNOWN_ERROR
- PLATFORM.IP_NOT_WHITELISTED
- PLATFORM.AUTHENTICATION_INVALID
- PLATFORM.TASK_TIMED_OUT
- INTEGRATION.PERMISSION_MISSING
- INTEGRATION.AUTHENTICATION_INVALID
- INTEGRATION.QA_FAILED
- INTEGRATION.SETUP_SYNC_PENDING
- INTEGRATION.SETUP_INCOMPLETE
- INTEGRATION.INACTIVE
- INTEGRATION.MODEL_NOT_AVAILABLE
- INTEGRATION.MODEL_DISABLED
- INTEGRATION.ACTION_NOT_AVAILABLE
- INTEGRATION.ACTION_DISABLED
- REMOTE.SERVICE_UNAVAILABLE
- REMOTE.RATE_LIMIT_EXCEEDED
- REMOTE.INPUT_INVALID
- REMOTE.UNKNOWN_HTTP_ERROR
- ATS.JOB_CLOSED
- ATS.APPLICATION_ALREADY_EXISTS
example: ATS.JOB_CLOSED
description: >-
Some errors include an error code that can be used to
identify their cause. See the [Error Handling
Docs](https://docs.kombo.dev/guides/errors) for more
information. For your error handling logic please use the
error `code` instead of other properties (e.g. message,
http status code, ...).
title:
type:
- string
- 'null'
description: A static, human-readable label.
message:
type: string
description: >-
A dynamic, detailed description of what went wrong in this
specific instance.
log_url:
type:
- string
- 'null'
format: uri
description: >-
The log page in the Kombo UI lists every interaction with
full details. If you need assistance, share that link with
our support team.
required:
- code
- title
- message
- log_url
description: Error details with structured code for programmatic handling.
required:
- status
- error
examples:
Error Response:
description: >-
When building error handling logic, always use the `code` field
to identify specific error types programmatically. See the
complete list of error codes in the
[docs](https://docs.kombo.dev/guides/errors).
value:
status: error
error:
code: INTEGRATION.MODEL_NOT_AVAILABLE
title: >-
This data model isn't supported for the selected
integration.
message: >-
The "employees" model is not yet available for Greenhouse.
Please reach out to Kombo if you need this functionality.
log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456
Minimal Error Response:
description: >-
The "message" is always required while other fields can also be
`null`. See the [docs](https://docs.kombo.dev/guides/errors) for
more information.
value:
status: error
error:
code: null
title: null
message: The message is always in the response.
log_url: null
securitySchemes:
ApiKey:
type: http
scheme: bearer
description: >-
Create an API key on the [Secrets](https://app.kombo.dev/secrets) page
in the Kombo dashboard.
````