Sign in
Namespace

Get namespace

Return the namespace identified by xid or slug under the organization. Lookup uses the same reachability as listing accessible namespaces so descendant-only users can open deep links. organization.read is not required.

get/v1/organizations/{organizationRef}/namespaces/{namespaceRef}

Response

OK

idstring required

Unique identifier of the namespace.

slugstring required

Organization-scoped canonical kebab-case slug.

namestring required

Name of the namespace.

descriptionstring nullable

Description of the namespace.

project_countinteger nullable

Number of projects in the namespace when projected.

document_countinteger nullable

Number of documents in the namespace when projected.

created_atstring date-time required

Date when the namespace was created.

updated_atstring date-time nullable required

Date when the namespace was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "slug": "platform",
  "name": "Engineering",
  "description": "Engineering team namespace",
  "project_count": 4,
  "document_count": 8,
  "organization": {
    "id": "9bsv0s46s6s002p9ltq0",
    "slug": "acme",
    "name": "ACME Inc."
  }
}

Changes