Group

Find all groups on a workspace

Changed on
get/v1/workspaces/{workspaceId}/user-groups

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/user-groups
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Query parameters

project-idstring

If provided, you'll get a filtered list of groups that matches the string provided in their project id.

namestring

If provided, you'll get a filtered list of groups that matches the string provided in their name.

Example:development_team
sort-column'ID' | 'NAME'

Column to be used as the sorting criteria.

sort-order'ASCENDING' | 'DESCENDING'

Sorting mode.

pageinteger

Page number.

Example:1
page-sizeinteger

Page size.

Example:50
includeTeamManagersboolean

If provided, you'll get a list of team managers assigned to this user group.

Example:true

Response

OK

idstring

Represents a user group identifier across the system.

namestring

Represents a user group name.

userIdsstring[]

Represents a list of users' identifiers across the system.

workspaceIdstring

Represents a workspace identifier across the system.

Example response

[
  {
    "id": "76a687e29ae1f428e7ebe101",
    "name": "development_team",
    "teamManagers": [
      {
        "id": "672323eb0024343a1585e8a7",
        "name": "Jane Doe"
      }
    ],
    "userIds": [
      "5a0ab5acb07987125438b60f",
      "98j4b5acb07987125437y32"
    ],
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]

Changes

  • a5b636acbcd8Revision changes
    • breaking

      for the query request parameter name, default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status