Practice Groups

Get a practice group

Changed on
get/workspaces/{workspaceSlug}/practice-groups/{groupSlug}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practice-groups/{groupSlug}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

groupSlugstring required

Response

Group returned

colorstring

Optional palette colour key for the group's chip

createdAtstring date-time required

Timestamp when the group was created

descriptionstring

What this group develops

displayOrderinteger required

Sort order within the workspace

iconstring

Optional lucide icon name for the group's chip

idinteger required

Group ID

namestring required

Human-readable name

slugstring required

URL-safe identifier unique within the workspace

updatedAtstring date-time

Timestamp when the group was last updated

visibleInPracticeDashboardsboolean required

Whether this group is shown in practice dashboards

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$