KOkombo
Unified ATS API

Get users

Changed on

Retrieve all users.

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)

get/ats/users

Request

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

updated_afterstring 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.

For this endpoint, updated_after matches when the returned record changed, or when related data changed as described below.

PathAdded/RemovedLinked Record
system_role_assignment✓ Yes✓ Yes

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.

idsstring

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

remote_idsstring

Filter by a comma-separated list of remote IDs.

emailsstring

Filter by a comma-separated list of emails. We will only return users who have any of the emails. The format of the emails is case-insensitive.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /ats/users Positive response

status'success' required

Example response

{
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@kombo.dev",
        "status": "ACTIVE",
        "remote_data": null,
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "system_roles": [
          {
            "remote_id": "1",
            "remote_label": "Admin",
            "unified_type": "ADMIN",
            "scope": "SYSTEM"
          }
        ]
      }
    ]
  }
}

Changes

  • d0e06abf1118Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the /// response's property type changed from string to string null, and format from email to no format for status

    • info

      added the new optional query request parameter emails

    • info

      added the new optional query request parameter ignore_unsupported_filters

    • info

      removed the pattern /^([\da-z]{24}(,[\da-z]{24})*)?$/i from the query request parameter ids

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      the response property const value success was added for the status

    • info

      removed the success enum value from the response property for the response status

    • info

      the /// response's property pattern ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ was added for the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status