Skip to main content
GET
List families

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

familyOwner
string
familyOwner[]
string[]
name
string

Response

200 - application/json

FamilyEntity collection

id
integer
read-only
name
string
familyOwner
object | null
dateCreated
string<date-time>
dateUpdated
string<date-time>