Skip to main content
Node.js

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
emails
string<email>[]
required
Example:
labels
string[] | null

Label names to grant access to. Null clears access

Example:
orgPhones
string[] | null

Phone numbers (without @c.us). Null clears access

Example:

Response

200 - application/json

200 OK

created_at
string

Timestamp when the member record was created

Example:

"2025-11-14T07:30:47.873008+00:00"

email
string

Email address of the member

Example:

"test@example.com"

user_id
string | null

User ID if the member has accepted the invite

Example:

null

invited_at
string

Timestamp when the member was invited

Example:

"2025-11-14T07:30:47.873008+00:00"

invited_by
string | null

ID of the user who sent the invitation

Example:

null

org_id
string

Organization ID that the member belongs to

Example:

"03a52dbe-b8af-47c5-9fd1-e5a622680cad"

role
string

Role assigned to the member (admin or member)

Example:

"member"

member_image
string | null

Profile image URL of the member

Example:

null

member_name
string | null

Display name of the member

Example:

null

is_active
boolean

Whether the member account is active

Example:

true

member_color
string | null

Color code assigned to the member for UI display

Example:

"#DB2777"

label_ids
string[]

Array of label IDs the member has access to

Example:
org_phones
string[]

Array of phone numbers the member has access to

Example:
is_owner
boolean | null

Whether the member is an organization owner

Example:

null

preferences
object

User interface preferences

is_online
boolean | null

Whether the member is currently online

Example:

null

member_metadata
object

Additional custom metadata for the member

Example: