API · Memberships
Memberships represent your team — the people who can sign in to your Usetix admin dashboard. Each membership has a role (scanner, manager, or owner) and a state (active or deactivated).
The API exposes memberships read-only. Inviting members, changing roles, or removing members must be done from the admin dashboard.
GET /admin/memberships
Returns active members, deactivated members, and pending invitations in one response.
curl -H "Authorization: Bearer your-token-here" \
-H "Accept: application/json" \
https://app.usetix.io/admin/memberships
Response:
{
"active": [
{
"id": 1,
"role": "owner",
"state": "active",
"created_at": "2025-09-01T10:00:00Z",
"user": {
"id": 1,
"name": "Jane Doe",
"email": "[email protected]"
}
}
],
"deactivated": [],
"pending_invitations": [
{
"id": 12,
"email": "[email protected]",
"role": "manager",
"created_at": "2026-04-22T12:00:00Z"
}
]
}
Membership fields
| Field | Type | Notes |
|---|---|---|
id |
integer | Internal numeric ID. |
role |
string | scanner, manager, or owner. |
state |
string | active or deactivated. |
created_at |
string | ISO 8601 UTC of when the membership was created. |
user.id |
integer | Internal user ID. Stable across membership changes. |
user.name |
string | User’s display name. |
user.email |
string | User’s email address. |
Pending invitation fields
| Field | Type | Notes |
|---|---|---|
id |
integer | Internal numeric ID. |
email |
string | Email address the invitation was sent to. |
role |
string | Role the invitee will receive on acceptance. |
created_at |
string | ISO 8601 UTC. |