> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # List scopes > Lists scopes: those `user_id` may publish to (your own, or another member's with `org_id` as an organization admin), optionally only `org_id`'s. Without `user_id`, site administrators get the full scope catalog. Requires membership in the organization given by `org_id`. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-organizations.yaml post /v1/orgs/get_scopes openapi: 3.0.3 info: title: 'CliqHub API: Organizations' version: 1.0.0 description: >- An organization owns realms, teams (through its scopes) and people. Every organization has four built-in roles, **Owner**, **Admin**, **Operator** and **Member**, and can define its own: a role is a named set of permissions (List permissions shows them all). Owners can do everything; `org.delete` and `org.transfer` belong to owners only. **Scopes** are the organization's package namespaces (`@acme`, `@acme-labs`): teams are published under a scope, and only the scope's members may publish to it. The organization's **team library** lists the teams its realms may use. Organization-wide notification rules also live here. People join an organization through Send an invitation. Organizations are created by site administrators for their future owner. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Organizations description: >- An organization owns realms, teams (through its scopes) and people. Every organization has four built-in roles, **Owner**, **Admin**, **Operator** and **Member**, and can define its own: a role is a named set of permissions (List permissions shows them all). Owners can do everything; `org.delete` and `org.transfer` belong to owners only. **Scopes** are the organization's package namespaces (`@acme`, `@acme-labs`): teams are published under a scope, and only the scope's members may publish to it. The organization's **team library** lists the teams its realms may use. Organization-wide notification rules also live here. People join an organization through Send an invitation. Organizations are created by site administrators for their future owner. paths: /v1/orgs/get_scopes: post: tags: - Organizations summary: List scopes description: >- Lists scopes: those `user_id` may publish to (your own, or another member's with `org_id` as an organization admin), optionally only `org_id`'s. Without `user_id`, site administrators get the full scope catalog. Requires membership in the organization given by `org_id`. operationId: POST_v1_orgs_get_scopes requestBody: required: true content: application/json: schema: type: object properties: user_id: type: string format: uuid description: >- User whose publish-access scopes to list; omit for full catalog (site admin only) org_id: type: string format: uuid description: Narrow results to scopes owned by this org query: type: string description: Substring match on slug or display_name limit: type: integer minimum: 1 maximum: 100 description: Maximum number of results to return (1–100) offset: type: integer minimum: 0 description: Zero-based offset for pagination sort_by: type: string enum: - slug - visibility - team_count - created_at description: >- Sort column: slug | visibility | team_count | created_at. Omit for the default order (a user\'s scopes by slug; the full catalog newest first). sort_dir: type: string enum: - asc - desc description: >- Sort direction with sort_by (default asc); ties are broken by id ascending examples: default: value: user_id: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d org_id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f responses: '200': description: >- `{ items, total, offset, limit }` for a user's scopes; `{ scopes, total, offset, limit }` for the catalog. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: type: object properties: items: type: array items: $ref: '#/components/schemas/ScopeData' scopes: type: array items: $ref: '#/components/schemas/ScopeData' total: type: integer offset: type: integer limit: type: integer example: ok: true data: items: - id: 6c7d8e9f-0a1b-4c2d-8e3f-4a5b6c7d8e9f slug: acme display_name: Acme visibility: public scope_type: org owner_id: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d org_id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f team_count: 5 created_at: '2026-01-10T00:00:00Z' total: 1 offset: 0 limit: 50 type: array '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: A daemon token was used; this route needs a user token. `forbidden`: You asked for another user's scopes without `org_id`, or for the full catalog without being a site administrator. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this forbidden (endpoint): summary: forbidden (endpoint) value: ok: false error: Listing all scopes requires an admin token code: forbidden '404': description: >- `not_found`: The organization does not exist or you are not a member. CliqHub answers 404, not 403, so it does not reveal which. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found '422': description: >- `invalid_params`: The body fails the request schema: a required field is missing or a value has the wrong type or format. The message lists every issue as `field: problem`. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'user_id: Required' code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: ScopeData: type: object properties: id: type: string format: uuid description: Scope UUID slug: type: string description: Unique scope slug (e.g. "acme" or "acme/tools") display_name: type: string nullable: true description: Human-readable name; null when not set visibility: type: string enum: - public - private description: Whether the scope is publicly browsable scope_type: type: string enum: - user - org description: >- "user" scopes are owned by a single user; "org" scopes are owned by an org owner_id: type: string format: uuid description: UUID of the owning user (user scopes) or org (org scopes) org_id: type: string format: uuid nullable: true description: Owning org UUID for org scopes; null for user scopes member_count: type: integer description: Number of users with publish access (included on detail views) team_count: type: integer description: >- Number of teams published under this scope (included on detail views) org_slug: type: string nullable: true description: Slug of the owning org (site-admin catalog listing) created_at: type: string description: ISO timestamp of scope creation required: - id - slug - display_name - visibility - scope_type - owner_id - org_id - created_at HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.