v1

latestOpenAPI 3.1.0Any Source Available License 1.02026-07-1736102200.0 KB
Spaces

List spaces

Retrieves a paginated list of all spaces that are accessible by the authenticated user. Each space record contains detailed information such as the space ID, name, icon (derived either from an emoji or image URL), and additional metadata. This endpoint is key to displaying a user's workspaces. Supports dynamic filtering via query parameters (e.g., ?name[contains]=project). See FilterCondition enum for available conditions.

get/v1/spaces

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

Headers

Anytype-Versionstring required

The version of the API to use

Response

The list of spaces accessible by the authenticated user

Example response

{
  "data": [
    {
      "description": "The local-first wiki",
      "gateway_url": "http://127.0.0.1:31006",
      "icon": {
        "emoji": "📄"
      },
      "id": "bafyreigyfkt6rbv24sbv5aq2hko3bhmv5xxlf22b4bypdu6j7hnphm3psq.23me69r569oi1",
      "name": "My Space",
      "network_id": "N83gJpVd9MuNRZAuJLZ7LiMntTThhPc6DtzWWVjb1M3PouVU",
      "object": "space"
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 100,
    "total": 1000
  }
}