Skip to main content

Read a namespace

Provides information about the namespace

Query Parameters
metadata_include string

Comma separated properties that should be included in the metadata response, available values [schemas, tags]

Example: schema,tags

Responses
200

An object representing the namespace

Schema OPTIONAL
id integer

A system-wide unique ID for the namespace

name string

Possible values: length ≤ 60

The namespace name

status array

Possible values: [active, inactive]

slug string

Possible values: length ≤ 60

An account-wide unique slug for the namespace

account_id integer

The ID of the account that owns this namespace

metadata object OPTIONAL

The metadata loaded via metadata api

key string OPTIONAL

The key of the metadata

value string OPTIONAL

The value of the metadata

additional_properties object OPTIONAL

Additional properties of the metadata

schemas array OPTIONAL

The json schemas of the metadata

tags object[] OPTIONAL
key string OPTIONAL
value string OPTIONAL