Skip to main content
GET
Error

Autorizações

Authorization
string
header
obrigatório

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.

Cabeçalhos

X-Organization-Id
string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.

Parâmetros de consulta

environment
enum<string>
padrão:live

Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.

Opções disponíveis:
live,
test
status
enum<string>

One column of the board.

Opções disponíveis:
open,
planned,
in_progress,
shipped,
declined
currency
string

ISO 4217, e.g. BRL. Computes weight on every post, in this currency.

sort
enum<string>
padrão:votes

weight needs currency.

Opções disponíveis:
votes,
weight

Resposta

The live posts, most-wanted first.

posts
object[]
statuses
string[]

The vocabulary, in the order a post travels it. Travels on the read so a screen cannot go on offering a value the API stopped accepting.

currency
string

Echoed when one was asked for, so a screen never labels an amount with a currency it assumed.