Members

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

10 endpoints.

GET /member

Get members.

Auth apikey

:::note Used by the web app components/SegmentComponent.jsx, pages/AddTeam.jsx, pages/AddWorkflow.jsx and 4 more :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is one Member object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /member

Invite member.

Auth apikey · Success 200

:::note Used by the web app components/SegmentComponent.jsx, pages/AddTeam.jsx, pages/AddWorkflow.jsx and 4 more :::

Request body

Field	Default
email	—
role	—
permission	—

Required: email.

Response — data is one Member object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors MemberAlredyExists_400 · RoleOrPermissionRequired_400

DELETE /member

Delete member.

Auth apikey · Success 200

:::note Used by the web app components/SegmentComponent.jsx, pages/AddTeam.jsx, pages/AddWorkflow.jsx and 4 more :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one Member object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /member/:id

Get member by id.

Auth apikey

:::note Used by the web app components/BulkInviteMembers.jsx, pages/InviteMember.jsx, pages/Leads.jsx and 1 more :::

Path parameters

Name
id	Required

Response — data is one User object.

Errors MemberNotFound_404

PUT /member/:id

Update member.

Auth apikey · Success 200

:::note Used by the web app components/BulkInviteMembers.jsx, pages/InviteMember.jsx, pages/Leads.jsx and 1 more :::

Path parameters

Name
id	Required

Request body

Field	Default
role	—
permission	—

Response — data is one Member object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors MemberNotFound_404

PUT /member/block/:id

Block member.

Auth apikey · Success 200

:::note Used by the web app pages/MemberManagement.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
reason	—

Response — data is one Member object. createdBy updatedBy is populated, so it arrives as nested objects rather than ids.

Errors MemberNotAccepted_400 · MemberNotFound_404

POST /member/bulk

Bulk invite members.

Auth apikey · Success 200

Request body

Field	Default
data	[]

Required: data, email, role. Of these, email, role are nested inside another field (commonly formData), or checked under a different internal name.

Response — data is one Member object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

ALL /member/invite/:id

Resend invitation.

Auth apikey · Success 200

:::note Used by the web app pages/MemberManagement.jsx :::

Path parameters

Name
id	Required

Response — data is one Member object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors MemberNotFound_404 · MemberNotInvited_400

PUT /member/transfer-ownership/:id

Transfer company ownership to another member.

Auth apikey · Success 200

:::note Used by the web app pages/MemberManagement.jsx :::

Path parameters

Name
id	Required

Response — data is one Member object. createdBy updatedBy is populated, so it arrives as nested objects rather than ids.

Errors DefaultRoleNotFound_404 · InvalidMemberStatus_400 · MemberNotFound_404

PUT /member/unblock/:id

Unblock member.

Auth apikey · Success 200

:::note Used by the web app pages/MemberManagement.jsx :::

Path parameters

Name
id	Required

Response — data is one Member object. createdBy updatedBy is populated, so it arrives as nested objects rather than ids.

Errors MemberNotBlocked_400 · MemberNotFound_404