Skip to main content

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

FieldTypeDescription
org_member_idstringUnique member identifier
first_namestringMember's first name
last_namestringMember's last name
emailstringMember's email address
rolestringOrganization-level role (admin, editor, viewer)
ou_membershipsarrayList of Organizational Unit memberships
ou_memberships[].unit_idstringOrganizational Unit identifier
ou_memberships[].unit_namestringOrganizational Unit name
ou_memberships[].rolestringRole within the OU
created_attimestampWhen the member was added

Example

curl -X GET "https://api.leadvibe.com/members" \
-H "Authorization: Bearer <token>"

Common Errors

StatusMeaningSolution
401UnauthorizedCheck authentication credentials

POST /members

Add a new member to your organization. An invitation email is sent automatically.

Request Body

FieldTypeRequiredDescription
first_namestringYesMember's first name
last_namestringYesMember's last name
emailstringYesMember's email address
passwordstringYesInitial password for the account
rolestringYesOrganization-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

StatusMeaningSolution
400Bad RequestCheck required fields and valid role value
401UnauthorizedCheck 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