Developers

The AntNexo API

Read and write your workspace's feedback from your own code: posts, votes, comments, customers, the roadmap and the changelog. Webhooks tell you when something happens.

New here? Start with the getting-started guide →

Base URL: https://app.antnexo.com/api/v1/ext
Authentication: Send a workspace API key (Settings → Developers) as Authorization: Bearer anx_…. A missing, unknown or revoked key is 401; a read key on a write is 403 scope_required. Your workspace's keys share its plan's requests per minute: every answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and past the limit you get 429 rate_limited with Retry-After. Within v1 the API only grows: ignore fields and values you don't know.
Errors: Errors are RFC 9457 problem+json: status, title, a code you can match on (like scope_required, rate_limited, invalid_cursor, id_conflict, plan_required), a detail and the request_id to quote when you write to us. A body that fails validation also lists the fields.

Me

GET/api/v1/ext/meRead key

The key's workspace, scope and rate limit; a cheap check that a key works

Responses

200 Who the key speaks for · ExtMe
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Boards

GET/api/v1/ext/boardsRead key

Every live board, public, private and inbox; one page

Responses

200 OK · ExtBoardList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

GET/api/v1/ext/boards/{board_id}Read key

One board

Parameters

board_id (path, uuid, required)

Responses

200 OK · ExtBoard
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Posts

GET/api/v1/ext/postsRead key

Posts on every board, newest first or by votes. Merged and spam posts only with include

Parameters

cursor (query, string, optional) — Opaque; the previous page's next_cursor. Omit it for the first page; a cursor of another list is 400 invalid_cursor.
limit (query, integer, optional)
board_id (query, uuid, optional)
status (query, list of string, optional) — Any of these (repeat the parameter)
category (query, string, optional)
initiative_id (query, uuid, optional)
author_email (query, string, optional)
q (query, string, optional) — Text in the title or body
created_after (query, date-time, optional)
updated_after (query, date-time, optional) — Changed after this time (a sync: pass the last run's start)
sort (query, string: newest | top, optional)
include (query, list of string, optional)

Responses

200 OK · ExtPostList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

POST/api/v1/ext/postsWrite key

File a post for a customer (idempotent by id): the author is made or updated by email and votes for it; source api, triaged as a customer's post. Any board; an inbox board needs the plan (403 plan_required)

Request body

ExtPostCreate

Responses

200 Already there (a retry, or a known person updated) · ExtPost
201 Created · ExtPost
429 Rate limited · Problem
default An error (RFC 9457) · Problem

GET/api/v1/ext/posts/{post_id}Read key

One post; a merged one has merged_into_id set

Parameters

post_id (path, uuid, required)

Responses

200 OK · ExtPost
429 Rate limited · Problem
default An error (RFC 9457) · Problem

PATCH/api/v1/ext/posts/{post_id}Write key

Change a post's status, category or initiative; followers hear of a status change as from the admin. If-Match (the version) is optional; a stale one is 412

Parameters

post_id (path, uuid, required)
If-Match (header, string, optional)

Request body

ExtPostUpdate

Responses

200 The post · ExtPost
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Votes

GET/api/v1/ext/posts/{post_id}/votesRead key

The customers who voted for the post, earliest first (the team's own votes aren't listed)

Parameters

post_id (path, uuid, required)
cursor (query, string, optional) — Opaque; the previous page's next_cursor. Omit it for the first page; a cursor of another list is 400 invalid_cursor.
limit (query, integer, optional)

Responses

200 OK · ExtVoteList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

POST/api/v1/ext/posts/{post_id}/votesWrite key

Add a customer's vote by their email (made or updated, as /ext/users); theirs, not the team's. 422 inbox_post on an inbox post, 409 post_merged on a merged one

Parameters

post_id (path, uuid, required)

Request body

ExtVoteInput

Responses

200 Already there · ExtVoteResult
201 Added · ExtVoteResult
429 Rate limited · Problem
default An error (RFC 9457) · Problem

DELETE/api/v1/ext/posts/{post_id}/votes/{user_id}Write key

Take an end user's vote back; 204 also when there was none

Parameters

post_id (path, uuid, required)
user_id (path, uuid, required)

Responses

204 Gone
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Comments

GET/api/v1/ext/posts/{post_id}/commentsRead key

The post's comments, oldest first, internal notes included

Parameters

post_id (path, uuid, required)
cursor (query, string, optional) — Opaque; the previous page's next_cursor. Omit it for the first page; a cursor of another list is 400 invalid_cursor.
limit (query, integer, optional)

Responses

200 OK · ExtCommentList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

POST/api/v1/ext/posts/{post_id}/commentsWrite key

Write a comment (idempotent by id). A member's address makes it the team's (internal allowed); any other is the customer's, made or updated by email, only on a post the public sees (403 not_allowed otherwise) and never internal

Parameters

post_id (path, uuid, required)

Request body

ExtCommentCreate

Responses

200 Already there · ExtComment
201 Added · ExtComment
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Users

GET/api/v1/ext/usersRead key

The end user with this email, if any (a list of zero or one)

Parameters

email (query, string, required)

Responses

200 OK · ExtUserList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

POST/api/v1/ext/usersWrite key

Make or update the end user with this email (201 new, 200 known: the fields given win, the rest stay); made verified

Request body

ExtUserInput

Responses

200 Already there (a retry, or a known person updated) · ExtUser
201 Created · ExtUser
429 Rate limited · Problem
default An error (RFC 9457) · Problem

GET/api/v1/ext/users/{user_id}Read key

One end user; 404 once erased

Parameters

user_id (path, uuid, required)

Responses

200 OK · ExtUser
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Initiatives

GET/api/v1/ext/initiativesRead key

Every initiative (the backlog and the roadmap); one page

Responses

200 OK · ExtInitiativeList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

GET/api/v1/ext/initiatives/{initiative_id}Read key

One initiative

Parameters

initiative_id (path, uuid, required)

Responses

200 OK · ExtInitiative
429 Rate limited · Problem
default An error (RFC 9457) · Problem

POST/api/v1/ext/initiatives/{initiative_id}/linksWrite key

Link the initiative to a work item in a tracker, like a Jira epic (idempotent by id). 409 link_exists, too_many_links (10).

Parameters

initiative_id (path, uuid, required)

Request body

ExtTrackerLinkCreate

Responses

200 Already linked with this id (a retry) · ExtTrackerLink
201 Linked · ExtTrackerLink
429 Rate limited · Problem
default An error (RFC 9457) · Problem

DELETE/api/v1/ext/initiatives/{initiative_id}/links/{link_id}Write key

Remove a tracker link from the initiative. 404 link_not_found.

Parameters

initiative_id (path, uuid, required)
link_id (path, uuid, required)

Responses

204 Removed
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Changelog

GET/api/v1/ext/changelogRead key

Changelog entries, drafts first (newest edited), then published (newest first)

Parameters

cursor (query, string, optional) — Opaque; the previous page's next_cursor. Omit it for the first page; a cursor of another list is 400 invalid_cursor.
limit (query, integer, optional)
state (query, string: draft | published, optional)

Responses

200 OK · ExtChangelogList
429 Rate limited · Problem
default An error (RFC 9457) · Problem

POST/api/v1/ext/changelogWrite key

Write a changelog draft (idempotent by id); publishing stays in the admin, as it emails customers

Request body

ExtChangelogCreate

Responses

200 Already there (a retry, or a known person updated) · ExtChangelogEntry
201 Created · ExtChangelogEntry
429 Rate limited · Problem
default An error (RFC 9457) · Problem

GET/api/v1/ext/changelog/{entry_id}Read key

One changelog entry

Parameters

entry_id (path, uuid, required)

Responses

200 OK · ExtChangelogEntry
429 Rate limited · Problem
default An error (RFC 9457) · Problem

Schemas

`ExtAuthor`

Field	Type
`email`	string	required
`id`	uuid	required · The end user (see /ext/users)
`name`	string or null	required

`ExtBoard`

Field	Type
`categories`	list of string	required
`created_at`	date-time	required
`id`	uuid	required
`name`	string	required
`slug`	string	required
`url`	string or null	required · The board's page; null for private and inbox boards
`visibility`	string	required · One of public, private, inbox · public: anyone sees it; private: the team only; inbox: anyone posts, only the team reads

`ExtBoardList`

Field	Type
`items`	list of ExtBoard	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtChangelogCreate`

Field	Type
`body`	string	required · Markdown
`id`	uuid	required
`initiative_ids`	list of uuid	optional
`title`	string	required

`ExtChangelogEntry`

Field	Type
`body`	string	required · Markdown
`created_at`	date-time	required
`id`	uuid	required
`initiative_ids`	list of uuid	required
`published_at`	date-time or null	required
`state`	string	required · One of draft, published
`title`	string	required
`updated_at`	date-time	required
`url`	string or null	required · The board's changelog page; null for drafts

`ExtChangelogList`

Field	Type
`items`	list of ExtChangelogEntry	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtComment`

Field	Type
`author`	ExtCommentAuthor or null	required · Null once the author deleted their account or erased their data
`body`	string	required
`created_at`	date-time	required
`id`	uuid	required
`internal`	boolean	required · A note only the team sees
`parent_id`	uuid or null	required
`post_id`	uuid	required

`ExtCommentAuthor`

Field	Type
`email`	string	required
`name`	string or null	required
`type`	string	required · One of member, customer · member: the team; customer: an end user

`ExtCommentCreate`

Field	Type
`author`	ExtUserInput	required
`body`	string	required
`id`	uuid	required · Client-generated (UUID v7)
`internal`	boolean	optional · A note only the team sees; members only
`parent_id`	uuid	optional · The comment this one answers

`ExtCommentList`

Field	Type
`items`	list of ExtComment	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtInitiative`

Field	Type
`column`	string	required · One of backlog, next, now, done · backlog: the team's only; next, now, done: also on the public roadmap
`created_at`	date-time	required
`id`	uuid	required
`links`	list of ExtTrackerLink	required · Links to work items in a tracker, oldest first
`post_count`	integer	required
`summary`	string	required
`title`	string	required
`updated_at`	date-time	required
`vote_count`	integer	required

`ExtInitiativeList`

Field	Type
`items`	list of ExtInitiative	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtKey`

Field	Type
`id`	uuid	required
`name`	string	required
`scope`	string	required · One of read, write · read reads everything; write also creates and changes

`ExtMe`

Field	Type
`key`	ExtKey	required
`rate_limit`	integer	required · Requests per minute the workspace's keys may make together (its plan's limit)
`workspace`	ExtWorkspace	required

`ExtPost`

Field	Type
`author`	ExtAuthor or null	required · Null for a guest post or once the author erased their data
`board_id`	uuid	required
`body`	string	required
`category`	string or null	required
`comment_count`	integer	required
`created_at`	date-time	required
`id`	uuid	required
`initiative_id`	uuid or null	required
`merged_into_id`	uuid or null	required · The post this one was merged into
`source`	string	required · Where it came from: board, widget, api, team, support, guest… (new values may appear)
`status`	string	required · One of open, under_review, planned, in_progress, done, closed
`title`	string	required
`triage`	string	required · One of new, accepted, spam · new: waits in the inbox; accepted: the team kept it; spam
`updated_at`	date-time	required
`url`	string or null	required · The post's page on the board; null on private and inbox boards
`version`	integer	required · Changes with every edit
`vote_count`	integer	required

`ExtPostCreate`

Field	Type
`author`	ExtUserInput	required
`board_id`	uuid	required
`body`	string	optional
`category`	string	optional · One of the board's categories
`id`	uuid	required · Client-generated (UUID v7); a retry with it returns the post
`title`	string	required

`ExtPostList`

Field	Type
`items`	list of ExtPost	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtPostUpdate`

Field	Type
`category`	string	optional · One of the board's categories; "" clears it
`initiative_id`	string	optional · An initiative's id; "" takes the post off its initiative
`status`	string	optional · One of open, under_review, planned, in_progress, done, closed

`ExtTrackerLink`

Field	Type
`created_at`	date-time	required
`id`	uuid	required
`key`	string	required · The work item's key, like SPL-1234; empty if none was given
`title`	string	required · Empty if none was given
`tracker`	string	required · One of jira, linear, github, other · From the URL's host: *.atlassian.net, linear.app, github.com
`url`	string	required · An https address

`ExtTrackerLinkCreate`

Field	Type
`id`	uuid	required · Client-generated (UUID v7)
`key`	string	optional · Like SPL-1234
`title`	string	optional
`url`	string	required · An https address

`ExtUser`

Field	Type
`company`	string or null	required
`created_at`	date-time	required
`email`	string	required
`id`	uuid	required
`mrr`	number or null	required · Monthly revenue from this customer, as you set it
`name`	string or null	required

`ExtUserInput`

Field	Type
`company`	string	optional
`email`	string	required
`mrr`	number	optional · Monthly revenue from this customer
`name`	string	optional

`ExtUserList`

Field	Type
`items`	list of ExtUser	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtVote`

Field	Type
`created_at`	date-time	required
`user`	ExtAuthor	required

`ExtVoteInput`

Field	Type
`user`	ExtUserInput	required

`ExtVoteList`

Field	Type
`items`	list of ExtVote	required
`next_cursor`	string or null	required · Pass it as cursor for the next page; null on the last one

`ExtVoteResult`

Field	Type
`post_id`	uuid	required
`user`	ExtAuthor	required
`vote_count`	integer	required

`ExtWorkspace`

Field	Type
`id`	uuid	required
`name`	string	required
`slug`	string	required

`FieldError`

Field	Type
`field`	string	required
`message`	string	required

`Problem`

Field	Type
`code`	string	optional · Stable machine-readable reason, e.g. invalid_code, slug_taken, stale
`detail`	string	optional
`errors`	list of FieldError	optional
`redirect_to`	string	optional · Where to send the browser instead of showing this error (an AI assistant's authorization request)
`request_id`	string	optional
`status`	integer	required
`title`	string	required
`type`	string	required