Skip to main content

Teams

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

4 endpoints.

GET /team

Get all team.

Auth apikey

:::note Used by the web app pages/AddTeam.jsx, pages/AddWorkflow.jsx, pages/Team.jsx :::

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

POST /team

Create team.

Auth apikey · Success 200

:::note Used by the web app pages/AddTeam.jsx, pages/AddWorkflow.jsx, pages/Team.jsx :::

Request body

FieldDefault
name
profileImage
isDefaultfalse
members
assignType
teamType

Required: name.

Errors TeamNameAlreadyExists_400

GET /team/:id

Get team.

Auth apikey

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

Path parameters

Name
idRequired

Errors TeamNotFound_400

PUT /team/:id

Update team.

Auth apikey · Success 200

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

Path parameters

Name
idRequired

Request body

FieldDefault
isDefault

Errors TeamNotFound_400