Skip to main content
GET
Who can reach it, and why

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

ref
string
required

An id, or an address

Query Parameters

who
string

One person, by id or email

Response

Holders

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
private
boolean
required
holders
object[]
required
on
object | null
required

What takes a grant here (a rule's or a page's brand); POST /api/v1/grants with it. Null for a portal

granted
object[]
required

The grants made on it, each changed with POST /api/v1/grants or taken back with DELETE /api/v1/grants/{grant}