# Get groups of an organization


[API catalog](/reference/api/) · [Docker Hub overview](/reference/api/hub/latest/) · [Product manual](https://docs.docker.com/docker-hub/) · [OpenAPI specification](/reference/api/hub/latest.yaml)

API version: 2-beta



`GET /v2/orgs/{org_name}/groups`

Get groups of an organization.

This operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.


## Connection and access

[API connection and authentication guidance](/reference/api/hub/latest/#authentication)


Server: `https://hub.docker.com`

Effective security: alternatives are OR; schemes within an alternative are AND. An empty array declares no HTTP authentication requirement.

```json
[
  {
    "bearerAuth": []
  }
]
```
## Example request

Replace placeholders and provide the required credentials or request body.

```console
curl \
  --request GET \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Accept: application/json' \
  'https://hub.docker.com/v2/orgs/myorganization/groups'
```

## Parameters

### org_name

Location: path. Required: yes.

Name of the organization (namespace).

```json
{
  "description": "Name of the organization (namespace).",
  "example": "myorganization",
  "in": "path",
  "name": "org_name",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/parameters/0",
  "required": true,
  "schema": {
    "type": "string"
  }
}
```

### page

Location: query. Required: no.

Page number (starts on 1).

```json
{
  "description": "Page number (starts on 1).",
  "in": "query",
  "name": "page",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/get/parameters/0",
  "schema": {
    "type": "integer"
  }
}
```

### page_size

Location: query. Required: no.

Number of items (rows) per page.

```json
{
  "description": "Number of items (rows) per page.",
  "in": "query",
  "name": "page_size",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/get/parameters/1",
  "schema": {
    "type": "integer"
  }
}
```

### username

Location: query. Required: no.

Get groups for the specified username in the organization.

```json
{
  "description": "Get groups for the specified username in the organization.",
  "in": "query",
  "name": "username",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/get/parameters/2",
  "schema": {
    "type": "string"
  }
}
```

### search

Location: query. Required: no.

Get groups for the specified group in the organization.

```json
{
  "description": "Get groups for the specified group in the organization.",
  "in": "query",
  "name": "search",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/get/parameters/3",
  "schema": {
    "type": "string"
  }
}
```

## Request and responses

### Response 200 application/json




Schema:

```json
{
  "examples": [
    {
      "count": 1,
      "next": null,
      "previous": null,
      "results": [
        {
          "description": "Development team",
          "id": 10,
          "member_count": 1,
          "name": "developers",
          "role": "member",
          "uuid": "e36eca69-4cc8-4f17-9845-ae8c2b832691"
        }
      ]
    }
  ],
  "properties": {
    "count": {
      "example": 1,
      "type": "number"
    },
    "next": {
      "example": null,
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "example": null,
      "type": [
        "string",
        "null"
      ]
    },
    "results": {
      "items": {
        "$ref": "#/components/schemas/org_group"
      },
      "type": "array"
    }
  },
  "type": "object"
}
```




Schema example:
```json
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "description": "Development team",
      "id": 10,
      "member_count": 1,
      "name": "developers",
      "role": "member",
      "uuid": "e36eca69-4cc8-4f17-9845-ae8c2b832691"
    }
  ]
}
```


### Response 401 application/json

Unauthorized


Schema:

```json
{
  "$ref": "#/components/schemas/error"
}
```




error:
```json
{
  "errinfo": null,
  "message": "unauthorized"
}
```


### Response 403 application/json

Forbidden


Schema:

```json
{
  "$ref": "#/components/schemas/error"
}
```




error:
```json
{
  "errinfo": null,
  "message": "permission denied"
}
```


### Response 404 application/json

Not Found


Schema:

```json
{
  "$ref": "#/components/schemas/error"
}
```




error:
```json
{
  "errinfo": null,
  "message": "not found"
}
```


## Complete operation contract

```json
{
  "description": "Get groups of an organization.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n",
  "operationId": "getV2OrgsByOrgNameGroups",
  "parameters": [
    {
      "$ref": "#/components/parameters/page"
    },
    {
      "$ref": "#/components/parameters/page_size"
    },
    {
      "description": "Get groups for the specified username in the organization.",
      "in": "query",
      "name": "username",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Get groups for the specified group in the organization.",
      "in": "query",
      "name": "search",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "examples": [
              {
                "count": 1,
                "next": null,
                "previous": null,
                "results": [
                  {
                    "description": "Development team",
                    "id": 10,
                    "member_count": 1,
                    "name": "developers",
                    "role": "member",
                    "uuid": "e36eca69-4cc8-4f17-9845-ae8c2b832691"
                  }
                ]
              }
            ],
            "properties": {
              "count": {
                "example": 1,
                "type": "number"
              },
              "next": {
                "example": null,
                "type": [
                  "string",
                  "null"
                ]
              },
              "previous": {
                "example": null,
                "type": [
                  "string",
                  "null"
                ]
              },
              "results": {
                "items": {
                  "$ref": "#/components/schemas/org_group"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        }
      },
      "description": ""
    },
    "401": {
      "$ref": "#/components/responses/unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/forbidden"
    },
    "404": {
      "$ref": "#/components/responses/not_found"
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "summary": "Get groups of an organization",
  "tags": [
    "groups"
  ]
}
```

## Referenced schemas

- `#/components/parameters/page`

- `#/components/parameters/page_size`

- `#/components/responses/forbidden`

- `#/components/responses/not_found`

- `#/components/responses/unauthorized`

- [#/components/schemas/org_group](/reference/api/hub/latest/schemas/org_group/)