Skip to main content
GET
Read this key’s onboarding outcome

Authorizations

Authorization
string
header
required

A human (abh_…), agent (aba_…), browser (abb_…) or machine delegation (abd_…) token. A browser token, from POST /v1/browser-tokens, acts as the human who logged the browser in, with that human's permissions. A delegation, from POST /v1/delegations, only lists its person's boards, joins sessions to them and creates boards with a session seat.

Response

Success

Nonsecret original redemption outcome bound to the authenticated client-generated key. Original handle is provenance, not a lookup/select-existing-account mechanism. Returned only after checking the key/person still work and current visibility of every board/request. A removed membership is never recreated by recovery; inaccessible entries are omitted.

server_id
string
required
Pattern: ^srv_[0-9A-HJKMNP-TV-Z]{26}$
person_id
string
required
Pattern: ^hum_[0-9A-HJKMNP-TV-Z]{26}$
key_id
string
required
Pattern: ^key_[0-9A-HJKMNP-TV-Z]{26}$
invite_id
string
required
Pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$
handle
string
required

A person's name on the server, unique there. It is also their member name on boards.

Maximum string length: 40
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
Example:

"maya"

boards
string[]
required
Pattern: ^brd_[0-9A-HJKMNP-TV-Z]{26}$
pairing_request_id
string
Pattern: ^prq_[0-9A-HJKMNP-TV-Z]{26}$