KOkombo
Unified HRIS API

Get teams (deprecated)

Changed on

Get the teams.

<Warning> **This endpoint is deprecated!**

Please use the /groups endpoint instead. It returns the same data but the naming makes more sense as the model not only includes teams but also departments and cost centers.. </Warning>

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/hris/teams

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, only changes to the returned record itself are considered.

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.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /hris/teams Positive response

status'success' required

Example response

{
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "4B9bKBpX5tnwjiG93TAqF7ci",
        "remote_id": "49",
        "name": "Customer Success",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "type": "TEAM",
        "parent_id": "KGaJ5XaVPob8mYVfD49W4DGB",
        "remote_data": null,
        "custom_fields": {},
        "integration_fields": []
      }
    ]
  }
}

Changes

  • 07bc44a61b06Revision changes
    • info

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

    • info

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

  • d0e06abf1118Revision changes
    • 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

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