Namespace

List reachable namespaces

Changed on

Return a cursor-paginated page of namespaces the actor can reach. A namespace is reachable when the actor has namespace.read on it or can read at least one descendant. Organization stubs are included without requiring organization.read.

get/v1/namespaces

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/namespaces
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token)

Query parameters

page_sizeinteger

Maximum number of items to return.

page_tokenstring

Opaque continuation token from a previous page_info.next_page_token.

Response

OK

Example response

{
  "items": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "slug": "platform",
      "name": "Engineering",
      "logo": "https://example.com/static/logo.png",
      "description": "Engineering team namespace",
      "project_count": 4,
      "document_count": 8,
      "organization": {
        "id": "9bsv0s46s6s002p9ltq0",
        "slug": "acme",
        "name": "ACME Inc."
      }
    }
  ]
}

Changes

  • 12e233bb333eRevision changes
    • info

      added the optional property // to the response with the status

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status