gitlab-org--gitlab-foss/doc/api/namespaces.md

Namespaces API

Usernames and groupnames fall under a special category called namespaces.

For users and groups supported API calls see the users and groups documentation respectively.

Pagination is used.

List namespaces

Get a list of the namespaces of the authenticated user. If the user is an administrator, a list of all namespaces in the GitLab instance is shown.

GET /namespaces

Example request:

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/namespaces

Example response:

[
  {
    "id": 1,
    "path": "user1",
    "kind": "user"
  },
  {
    "id": 2,
    "path": "group1",
    "kind": "group"
  },
  {
    "id": 3,
    "path": "bar",
    "kind": "group",
    "full_path": "foo/bar",
  }
]

Search for namespace

Get all namespaces that match a string in their name or path.

GET /namespaces?search=foobar

Attribute	Type	Required	Description
search	string	no	Returns a list of namespaces the user is authorized to see based on the search criteria

Example request:

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/namespaces?search=twitter

Example response:

[
  {
    "id": 4,
    "path": "twitter",
    "kind": "group",
    "full_path": "twitter",
  }
]