Members API
Manage team members within your organization. Members are users who can sign in to LeadVibe and access data across Organizational Units based on their assigned role.
GET /members
List all members in your organization, including their role and Organizational Unit memberships.
Request
No query parameters required.
Response
200 OK
[
{
"org_member_id": "mem_abc123",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"role": "admin",
"ou_memberships": [
{
"unit_id": "unit_default",
"unit_name": "Default",
"role": "editor"
}
],
"created_at": "2025-06-01T10:00:00Z"
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
org_member_id | string | Unique member identifier |
first_name | string | Member's first name |
last_name | string | Member's last name |
email | string | Member's email address |
role | string | Organization-level role (admin, editor, viewer) |
ou_memberships | array | List of Organizational Unit memberships |
ou_memberships[].unit_id | string | Organizational Unit identifier |
ou_memberships[].unit_name | string | Organizational Unit name |
ou_memberships[].role | string | Role within the OU |
created_at | timestamp | When the member was added |
Example
curl -X GET "https://api.leadvibe.com/members" \
-H "Authorization: Bearer <token>"
Common Errors
| Status | Meaning | Solution |
|---|---|---|
| 401 | Unauthorized | Check authentication credentials |
POST /members
Add a new member to your organization. An invitation email is sent automatically.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
first_name | string | Yes | Member's first name |
last_name | string | Yes | Member's last name |
email | string | Yes | Member's email address |
password | string | Yes | Initial password for the account |
role | string | Yes | Organization-level role: admin, editor, or viewer |
{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"password": "securepassword123",
"role": "editor"
}
Response
200 OK
Returns the created member object.
Example
curl -X POST "https://api.leadvibe.com/members" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"password": "securepassword123",
"role": "editor"
}'
Common Errors
| Status | Meaning | Solution |
|---|---|---|
| 400 | Bad Request | Check required fields and valid role value |
| 401 | Unauthorized | Check authentication credentials |
Notes
- Members are organization-scoped and can be granted access to specific Organizational Units
- Available roles:
admin(full access),editor(read/write),viewer(read-only) - A welcome email is sent automatically when a member is created
- Members can be assigned to OUs via the Organization Units memberships endpoints
Related Endpoints
- Member by ID - Update or remove a member
- Organization Units - Manage OU access and memberships