# Channel API Reference

OpenAPI source: https://api.are.na/v3/openapi.json

## GET /v3/channels/{id}/connections

- Label: Get channel connections
- Docs: https://www.are.na/developers/explore/channel/connections
- Markdown: https://www.are.na/developers/explore/channel/connections.md
- Requires resource id: yes
- Response content type: application/json

Returns paginated list of channels where this channel appears.
This shows all channels that contain this channel, respecting visibility rules and user permissions.

Path parameters:
- id: string (required) — Resource ID or slug

Query parameters:
- page: number (optional) — Page number for pagination
- per: number (optional) — Number of items per page (max 100)
- sort: select (optional) options=created_at_desc|created_at_asc — Sort by the date the relationship was created.

Response schema:
```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "Array of channels",
      "items": {
        "type": "object",
        "required": [
          "id",
          "type",
          "slug",
          "title",
          "state",
          "visibility",
          "created_at",
          "updated_at",
          "owner",
          "counts",
          "_links"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "nullable": false,
            "description": "Unique identifier for the channel",
            "example": 12345
          },
          "type": {
            "type": "string",
            "nullable": false,
            "description": "Channel type",
            "enum": [
              "Channel"
            ],
            "example": "Channel"
          },
          "slug": {
            "type": "string",
            "nullable": false,
            "description": "Channel URL slug",
            "example": "my-collection-abc123"
          },
          "title": {
            "type": "string",
            "nullable": false,
            "description": "Channel title",
            "example": "My Collection"
          },
          "description": {
            "type": "oneOf",
            "description": "Channel description with multiple renderings",
            "variants": [
              {
                "type": "object",
                "description": "Markdown content with multiple renderings",
                "…": "see OpenAPI spec for full schema"
              },
              {
                "type": "unknown",
                "nullable": true
              }
            ]
          },
          "state": {
            "type": "string",
            "nullable": false,
            "description": "Lifecycle state of a channel.\n- `available`: Active and accessible\n- `deleted`: Soft deleted\n",
            "enum": [
              "available",
              "deleted"
            ],
            "refName": "ChannelState"
          },
          "visibility": {
            "type": "string",
            "nullable": false,
            "description": "Visibility level of a channel:\n- `public`: Anyone can view and connect to the channel\n- `private`: Only the owner and collaborators can view\n- `closed`: Anyone can view, but only collaborators can add content\n",
            "enum": [
              "public",
              "private",
              "closed"
            ],
            "refName": "ChannelVisibility"
          },
          "created_at": {
            "type": "string",
            "nullable": false,
            "description": "When the channel was created",
            "format": "date-time",
            "example": "2023-01-15T10:30:00Z"
          },
          "updated_at": {
            "type": "string",
            "nullable": false,
            "description": "When the channel was last updated",
            "format": "date-time",
            "example": "2023-01-15T14:45:00Z"
          },
          "metadata": {
            "type": "oneOf",
            "description": "Custom key-value metadata",
            "variants": [
              {
                "type": "object",
                "description": "Arbitrary key-value pairs stored on an entity.\nKeys are alphanumeric/underscore, max 40 characters.\nValues are scalars (string, number, boolean). Max 50 keys, 32KB total.\n",
                "…": "see OpenAPI spec for full schema"
              },
              {
                "type": "unknown",
                "nullable": true
              }
            ]
          },
          "owner": {
            "type": "oneOf",
            "description": "Channel owner (User or Group)",
            "variants": [
              {
                "type": "object",
                "description": "Embedded user representation (used when user is nested in other resources)",
                "…": "see OpenAPI spec for full schema"
              },
              {
                "type": "object",
                "description": "Embedded group representation (used when group is nested in other resources)",
                "…": "see OpenAPI spec for full schema"
              }
            ],
            "refName": "ChannelOwner"
          },
          "counts": {
            "type": "object",
            "description": "Counts of various items in the channel",
            "required": [
              "blocks",
              "channels",
              "contents",
              "collaborators"
            ],
            "properties": {
              "blocks": {
                "type": "integer",
                "nullable": false,
                "description": "Number of blocks in the channel",
                "example": 42
              },
              "channels": {
                "type": "integer",
                "nullable": false,
                "description": "Number of channels connected to this channel",
                "example": 8
              },
              "contents": {
                "type": "integer",
                "nullable": false,
                "description": "Total number of contents (blocks + channels)",
                "example": 50
              },
              "collaborators": {
                "type": "integer",
                "nullable": false,
                "description": "Number of collaborators on the channel",
                "example": 3
              }
            },
            "refName": "ChannelCounts"
          },
          "collaborators": {
            "type": "array",
            "description": "Collaborators on this channel (users and groups).\nOnly present when channel is returned as a full resource, not when embedded.\n",
            "items": {
              "type": "oneOf",
              "description": "Channel collaborator (User or Group)",
              "…": "see OpenAPI spec for full schema"
            }
          },
          "_links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "description": "A hypermedia link containing the URL of a linked resource.\nThe relationship type is expressed by the key in the parent _links object.\n",
                "…": "see OpenAPI spec for full schema"
              }
            },
            "required": [
              "self"
            ],
            "description": "HATEOAS links for navigation and discovery.\nFollows HAL (Hypertext Application Language) format where link relationships \nare expressed as object keys (e.g., \"self\", \"user\", \"channels\").\n"
          },
          "connection": {
            "type": "oneOf",
            "description": "Connection context (only present when channel is returned as part of another channel's contents).\nContains position, pinned status, and information about who connected the channel.\n",
            "variants": [
              {
                "type": "object",
                "description": "Embedded connection representation used when connection is nested in other resources",
                "…": "see OpenAPI spec for full schema"
              },
              {
                "type": "unknown",
                "nullable": true
              }
            ]
          },
          "can": {
            "type": "oneOf",
            "description": "Actions the current user can perform on this channel.\nOnly present when channel is returned as a full resource, not when embedded.\n",
            "variants": [
              {
                "type": "object",
                "description": "Actions the current user can perform on the channel",
                "…": "see OpenAPI spec for full schema"
              },
              {
                "type": "unknown",
                "nullable": true
              }
            ]
          }
        },
        "refName": "Channel"
      }
    },
    "meta": {
      "type": "object",
      "description": "Pagination metadata",
      "required": [
        "current_page",
        "per_page",
        "total_pages",
        "total_count",
        "has_more_pages"
      ],
      "properties": {
        "current_page": {
          "type": "integer",
          "nullable": false,
          "description": "Current page number",
          "example": 1
        },
        "next_page": {
          "type": "integer",
          "nullable": true,
          "description": "Next page number (null if last page)",
          "example": 2
        },
        "prev_page": {
          "type": "integer",
          "nullable": true,
          "description": "Previous page number (null if first page)"
        },
        "per_page": {
          "type": "integer",
          "nullable": false,
          "description": "Number of items per page",
          "example": 25
        },
        "total_pages": {
          "type": "integer",
          "nullable": false,
          "description": "Total number of pages available",
          "example": 5
        },
        "total_count": {
          "type": "integer",
          "nullable": false,
          "description": "Total number of items available",
          "example": 120
        },
        "has_more_pages": {
          "type": "boolean",
          "nullable": false,
          "description": "Whether there are more pages available",
          "example": true
        }
      },
      "refName": "PaginationMeta"
    }
  },
  "required": [
    "data",
    "data",
    "meta"
  ],
  "description": "Paginated list of channels with total count",
  "refName": "ChannelListResponse"
}
```