Get groups of an organization Run in API Explorer

GET /v2/orgs/{org_name}/groups
Bearer auth

Path parameters

  • org_name string Required

    Name of the organization (namespace).

Query parameters

  • page integer

    Page number (starts on 1).

  • page_size integer

    Number of items (rows) per page.

  • username string

    Get groups for the specified username in the organization.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • count number
    • next string
    • previous string
    • results array[object]
      Hide results attributes Show results attributes object
      • id number

        Group ID

      • uuid string

        UUID for the group

      • name string

        Name of the group

      • description string

        Description of the group

      • member_count number

        Member count of the group
  • 401 application/json

    Authentication failed

    Hide response attributes Show response attributes object
    • errinfo object
    • detail string
    • message string
  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
    • errinfo object
    • detail string
    • message string
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • errinfo object
    • detail string
    • message string
GET /v2/orgs/{org_name}/groups 
curl \
 --request GET 'https://hub.docker.com/v2/orgs/myorganization/groups' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "count": 1,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "id": 10,
      "uuid": "string",
      "name": "mygroup",
      "description": "Groups description",
      "member_count": 10
    }
  ]
}
Response examples (401) 
{
  "errinfo": {},
  "detail": "string",
  "message": "string"
}
Response examples (403) 
{
  "errinfo": {},
  "detail": "string",
  "message": "string"
}
Response examples (404) 
{
  "errinfo": {},
  "detail": "string",
  "message": "string"
}