Hilfe

Hier findet ihr Anleitungen, Erklärungen und alles Wichtige rund um Wortfreunde. Damit ihr das Beste aus eurer Content Arbeit herausholen könnt.

Channels API

Channels represent publishing destinations in Wortfreunde, a blog, a LinkedIn profile, a newsletter, etc. Each channel belongs to a team and contains posts.

Endpoints

MethodEndpointDescription
GET/channelsList all channels
GET/channels/{id}Get a single channel

List Channels

Retrieve a paginated list of all channels accessible with your API key.

GET /channels

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger20Items per page (max: 100)

Example Request

curl -s https://api.wortfreunde.ch/v1/channels \
  -H "Authorization: Bearer $WORTFREUNDE_API_KEY" | python3 -m json.tool

Response

{
  "data": [
    {
      "id": 161,
      "title": "Blog",
      "platform": "git",
      "team": {
        "id": 42,
        "name": "Wortfreunde"
      },
      "posts_count": 3
    },
    {
      "id": 17,
      "title": "LinkedIn",
      "platform": "linkedin",
      "team": null,
      "posts_count": 5
    },
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "count": 5,
    "per_page": 20
  }
}

Response Fields

FieldTypeDescription
idintegerUnique channel identifier
titlestringDisplay name of the channel
platformstringPlatform type (see below)
teamobject | nullTeam the channel belongs to
team.idintegerTeam identifier
team.namestringTeam display name
posts_countintegerNumber of posts in the channel

Platform Types

PlatformDescription
blogStandard blog channel
gitGit-backed content (e.g. static site)
linkedinLinkedIn publishing

Pagination

The meta object contains pagination details:

FieldTypeDescription
pageintegerCurrent page number
pagesintegerTotal number of pages
countintegerTotal number of channels
per_pageintegerItems per page

Get Channel

Retrieve a single channel by its ID.

GET /channels/{id}

Path Parameters

ParameterTypeDescription
idintegerChannel ID

Example Request

curl -s https://api.wortfreunde.ch/v1/channels/161 \
  -H "Authorization: Bearer $WORTFREUNDE_API_KEY" | python3 -m json.tool

Response

{
  "data": {
    "id": 161,
    "title": "Blog",
    "platform": "git",
    "team": {
      "id": 42,
      "name": "Wortfreunde"
    },
    "posts_count": 3,
    "created_at": "2026-02-26T09:34:58.251Z",
    "updated_at": "2026-02-26T15:29:05.704Z"
  }
}

Response Fields

The single channel response includes all fields from the list response, plus:

FieldTypeDescription
created_atstringISO 8601 creation timestamp
image_widthintegerDefault image width in pixels for this channel
updated_atstringISO 8601 last update timestamp

Error Responses

Channel Not Found

curl -s https://api.wortfreunde.ch/v1/channels/99999 \
  -H "Authorization: Bearer $WORTFREUNDE_API_KEY"
{
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}
StatusDescription
401Invalid or missing API key
403Insufficient scopes, requires read:channels
404Channel not found
429Rate limit exceeded