---
title: "Team access: Read the shared collection and accessible base references."
method: GET
path: "/api/teams/{organization_id}/collections/{collection_id}"
---

# Team access: Read the shared collection and accessible base references.

`GET /api/teams/{organization_id}/collections/{collection_id}`

## Request

- Base URL: `https://okfindex.com`
- URL: `https://okfindex.com/api/teams/{organization_id}/collections/{collection_id}`
- Auth: none declared

Team access uses current account membership, product access and resource sharing on every request. Revocation also blocks search, originals, Markdown, OKF and ZIP downloads with an existing session or key. Sharing a collection grants current and future files in its owner's referenced bases; other owners' bases expose published files only. Sharing does not publish a resource. Only the resource owner changes sharing. The initial grant requires the owner's session with origin and CSRF checks. Organization API keys stay within their existing grants. Responses use private, no-store.
Returns: { collection{id,name,visibility,created_at,api,public_url}, items[{base,own,published}], next, read_only }

## Path parameters

- `organization_id` string, required
- `collection_id` string, required

## Response `200`

{ collection{id,name,visibility,created_at,api,public_url}, items[{base,own,published}], next, read_only }

- object
  - `collection` KnowledgeCollection, required
    - `id` string, required: The 64-character ID returned by this API.
    - `name` string, required: The owner-selected collection name.
    - `visibility` string, required: private or public; new collections start private.
    - `created_at` string, required: UTC creation timestamp.
    - `api` string, required: Authorized API URL for this view.
    - `public_url` string, nullable, required: Public collection page, or null before publication.
  - `items` CollectionReference[], required: Currently accessible base references. Content stays in its original base.
    - `base` Base, required
      - `id` string, required: The 64-character ID returned by the API.
      - `name` string, required: Base name.
      - `visibility` string, required: private or public; only explicit publication makes a base public.
      - `dataset` Dataset, required
        - `description` string, required: Dataset description, 1–2000 characters.
        - `fields` DatasetField[], required: 1–30 fields, each with a name and description.
          - `name` string, required: Field name, 1–80 characters.
          - `description` string, required: Meaning, 1–200 characters.
        - `coverage` string, required: Geographic, temporal or subject coverage, 1–300 characters.
        - `format` string, required: Source format, for example CSV or JSON, 1–40 characters.
        - `update_frequency` string, required: Declared update schedule, 1–200 characters. No automatic check is performed.
        - `license` string, required: Declared license or access terms, 1–300 characters. Not independently verified.
        - `source_url` string, required: HTTPS origin URL, at most 1000 characters, without credentials.
      - `created_at` string, required: Creation date, ISO 8601.
      - `updated_at` string, required: Last change, ISO 8601.
      - `documents` integer, nullable, required: Document count when returned by the base list; null otherwise.
      - `bytes` integer, nullable, required: Current original bytes in the owner's base list; null in other private responses. Omitted from public responses.
      - `api` string, required: Metadata URL.
      - `export_url` string, required: ZIP download URL.
      - `okf_url` string, required: OKF root index URL.
      - `public_url` string, nullable, required: Public page URL while published; null when private.
      - `embed_url` string, nullable, required: Public search iframe URL while published; null when private. Uses the same public API and limits. No account controls inside the iframe.
      - `publication` BasePublication, required
        - `author` string, required: Author or attribution declared by the publisher.
        - `source_url` string, nullable, required: Declared HTTPS source, or null for uploaded files.
        - `terms` string, required: Terms declared by the publisher. This is not an independent license verification.
        - `published_at` string, required: Date of the last explicit publication, ISO 8601.
    - `own` boolean, required: Whether this account owns the base; always false in a public view.
    - `published` boolean, required: Whether the reference was included in publication and the base remains public.
  - `next` string, nullable, required: Next page URL, or null when the bounded result is complete.
  - `read_only` boolean, required: Always true. Only the personal owner can edit files or collection references.

## Other responses

- `400`: Invalid query or cursor.
- `401`: A valid session or organization API key is required.
- `403`: Organization access requires the correct credential and, when applicable, MFA.
- `404`: The organization, resource or sharing grant is inaccessible.
- `405`: Team access is read-only.
- `409`: A file is not ready for export.
- `503`: Account or knowledge storage is unavailable.

---

[API](https://skmtc.dev/okfindex/apis/okf-index.md) · [All operations](https://skmtc.dev/okfindex/apis/okf-index/llms.txt) · [OpenAPI document](https://skmtc.dev/okfindex/apis/okf-index/revisions/4b13ca3c739f?raw)
