COcoder
Enterprise

Get group by ID

Changed on
get/api/v2/groups/{group}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/groups/{group}
  • Auth
    API key in header Coder-Session-Token

Path parameters

groupstring required

Group id

Query parameters

exclude_membersboolean

Exclude members from the response

Response

OK

avatar_urlstring uri
display_namestring
idstring uuid
namestring
organization_display_namestring
organization_idstring uuid
organization_namestring
quota_allowanceinteger
source'user' | 'oidc'
total_member_countinteger

How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than len(Group.Members).

Changes