retrieval

List retrieval namespaces

Returns the namespace hierarchy for managed retrieval. Namespaces use dot-separated paths (e.g. docs.api, docs.guides). Use parent to list children of a specific namespace and depth to control nesting. Without parent, the response's parent is null and namespaces holds the top-level namespaces.

Required permission: retrieval.manage.

get/v1/projects/{project_id}/retrieval/namespaces

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/retrieval/namespaces
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment ID from GET /environments.

parentstring nullable

List the namespaces below this one, such as docs. The response's parent then describes it.

depthinteger

Levels to return: 1 returns only the direct children of parent (or the top level), 0 returns all levels.

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.