Manage organization settings and team member access.
The Organizations API allows you to manage organization-level settings, team members, and access permissions programmatically.
/organization{
"id": "org_efg234",
"name": "Acme Corporation",
"plan": "professional",
"created_at": "2023-06-15T10:00:00Z",
"settings": {
"timezone": "America/New_York",
"date_format": "MM/DD/YYYY",
"default_exam_duration": 60,
"branding_enabled": true,
"sso_enabled": false
},
"team_size": 5,
"active_candidates": 234
}/organization| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Optional | Organization name |
| settings | object | Optional | Settings object with fields to update |
/organization/members{
"data": [
{
"id": "user_hij567",
"email": "admin@acme.com",
"name": "John Doe",
"role": "admin",
"status": "active",
"last_active": "2024-02-12T08:30:00Z",
"created_at": "2023-06-15T10:00:00Z"
}
],
"pagination": { "total": 5, "limit": 20, "has_more": false }
}/organization/members| Name | Type | Required | Description |
|---|---|---|---|
| string | Required | Email address | |
| role | string | Required | Role: admin, member, viewer |
| name | string | Optional | Full name |
/organization/members/{member_id}/organization/members/{member_id}Role changes take effect immediately. Removed members lose access instantly and cannot be restored (they must be re-invited).
| Role | Permissions |
|---|---|
| admin | Full access including billing and team management |
| member | Create exams, invite candidates, view results |
| viewer | Read-only access to candidates and results |
Was this article helpful?