Back to Help

API endpoints

April 15, 2026

The full OmniCon API surface grouped by resource — articles, channels, authors, books, press, media, organizations.

A map of the API surface, grouped by resource. For full request and response shapes, the Swagger UI at https://api.omnicon.cloud/ is always the source of truth — this page is for getting oriented.

All endpoints below require a bearer token (see Authentication) unless noted otherwise.

Auth — /api/auth

  • POST /login — exchange username and password for a JWT. Anonymous.
  • GET /me — get the authenticated user's profile.

Articles — /api/articles

  • POST /article — get an article by id or permalink (also logs an impression).
  • POST /articles — list and search articles with keyword, tag, folder, author, sort, and pagination. Returns items plus facet counts.
  • POST /articles-stats — facet-only stats (tags, folders) for a channel. Good for sidebar UIs.
  • POST /article/create, POST /article/update, DELETE /article/delete — CRUD.
  • POST /article/append-comment, POST /article/delete-comment, POST /article/flag-comment — comment moderation.
  • GET /article/folders, POST /article/folders, PUT /article/folders, DELETE /article/folders/{folderId} — folder management within a channel.

See Articles, tags and folders, and publish windows for the concepts behind these fields.

Channels — /api/channel

  • POST /channels — list channels in an organization (keyword, sort, pagination).
  • POST /channel, GET /channel/by-permalink/{permaName} — fetch channel details.
  • POST /channel/create, PUT /channel/update, DELETE /channel/delete — CRUD. Use update for navigation and custom domain changes.
  • GET /channel/memberships, POST /channel/memberships, PUT /channel/memberships, DELETE /channel/memberships/{id} — team management.
  • GET /channel/subscribers, POST /channel/subscribe, POST /channel/unsubscribe — reader subscriptions.

Authors — /api/authors

  • GET /?channelId= — list authors in a channel.
  • GET /{id}, GET /by-permalink/{permaName} — fetch a single author.
  • POST /, PUT /{id}, DELETE /{id} — CRUD.

Remember authors are per channel, not per user.

Books — /api/books

Books, Parts, Chapters, and Sections are four nested levels. Each level has its own CRUD plus an order endpoint to reorder siblings.

  • GET /?channelId=, GET /{id}, POST /, PUT /{id}, DELETE /{id} — book CRUD.
  • GET /{id}/export — returns a .docx of the whole book.
  • /parts, /chapters, /sections — same shape: GET /{id}, POST /, PUT /{id}, PUT /{id}/order, DELETE /{id}.

See Book structure for how the levels nest.

Press releases — /api/press

  • GET /contacts, POST /contacts, PUT /contacts/{id}, DELETE /contacts/{id} — press contacts.
  • GET /lists, POST /lists, DELETE /lists/{id}, POST /lists/{listId}/members, DELETE /lists/{listId}/members/{contactId} — distribution lists.
  • POST /send — send a press release (takes a channelId, an article RowKey, a subject, optional custom message, and a list of contactIds).
  • GET /distributions, GET /distributions/{id} — distribution history.

Media — /api/media

  • GET / — list files with paging, name/type/size filters, and a continuation token.
  • GET /metadata, GET /url — inspect a single file.
  • POST /upload — multipart upload. POST /upload-image also generates a 150×150 thumbnail.
  • POST /upload-url — request a 30-minute pre-signed URL for direct-to-storage uploads (no payload through the API).
  • DELETE / — delete a file.

Organizations — /api/organization

  • POST /organizations — list organizations you belong to.
  • POST /organization — get details for a single organization.

Organization creation and team invites are dashboard-only today.

For working copy-paste flows, see Examples.

api endpoints reference