Sign in

v1

latestOpenAPI 3.1.02026-07-26183980.3 KB
external
external-v2

Read Collection

Fetch metadata for a single collection by ID. This endpoint returns collection metadata only, not a note list for that collection. For discovery flows, use GET /v2/collections or POST /v2/collections/search.

get/v2/collections/{collection_id}

Path parameters

collection_idstring uuid required

UUID of the collection to read. Use an ID returned by create/list/search. The caller must be able to access this collection.

UUID of the collection to read. Use an ID returned by create/list/search. The caller must be able to access this collection.

Response

OK

created_atstring date-time required

Creation timestamp for the collection in ISO 8601 format.

descriptionstring nullable required

Optional description text currently stored on the collection.

idstring uuid required

UUID of the requested collection.

note_countinteger required

Current number of notes in the collection.

request_idstring required

Identifier for this API request. Useful for tracing and support.

titlestring required

Current title of the collection.

updated_atstring date-time required

Last modification timestamp for the collection in ISO 8601 format.

Example response

{
  "created_at": "2025-04-11T04:47:14.457Z",
  "description": "Anything related to Acme Corp; a software company that provides a suite of tools for managing customer relationships.",
  "id": "5e29c8a2-c73b-476b-9311-e2579712d4b1",
  "note_count": 12,
  "request_id": "api-request-036ed6c7-de00-459f-a89b-43d26aafe522",
  "title": "Acme Corp",
  "updated_at": "2025-04-11T04:47:19.702Z"
}