Group Policies

List all group policies

Changed on

Returns a list of group_policies. By default, only active and scheduled group policies are returned. Use the status query parameter to filter by other statuses. The group_policies are returned sorted by creation date, with the most recent group_policy appearing first.

get/group_policies

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/group_policies
  • Auth
    HTTP bearer

Query parameters

employer_idstring

Filters group policies by employer.

Example:er_3b1333d87d9d4fd6ad83ba7f6b0e951a
group_idstring

Filters group policies by group.

Example:gr_3b1333d87d9d4fd6ad83ba7f6b0e951a
statusstring

Multiple values can be provided by separating them with a comma. Allowed values are: scheduled, active, expired, cancelled.

pageinteger

The page of results to return. Defaults to 1 if not provided.

page_sizeinteger

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

OK

pageinteger required

The current page of the results

page_sizeinteger required

The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size

total_countinteger required

The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.

has_next_pageboolean

Whether there are more pages available after this page

has_previous_pageboolean

Whether there are more pages available before this page

Changes

  • 998f7cb004abRevision changes
    • warning

      deleted the header request parameter X-Platform-Id

  • ce9736d28f93Revision changes
    • warning

      added the new pooled_member_count enum value to the ///////////////////// response property for the response status

    • warning

      added the new pooled_member_count enum value to the ///////////////////// response property for the response status

    • info

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

    • info

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

    • info

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