Teams API
4 endpoints
POST
/api/v01/teams/create
Add a team member to a team. Auto-creates user if not found.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| team.item | string | yes | Team (business) item ID |
| user.name | string | yes | Member full name |
| user.mail | string | no | Member email address |
| user.mobile.code | string | no | Mobile country code |
| user.mobile.number | string | no | Mobile number |
| role | string | no | 'admin' or 'member' (default: 'member') |
| menu | array | no | Permission menu items |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| team | object | no | { name, nuvo, item } |
| user | object | no | { name, mail, mobile, nuvo, item } |
| sort | string | no | Record sort — always 'user' |
| role | string | no | Assigned role |
| menu | array | no | Permission menu items |
| active | boolean | no | Active status |
| item | string | no | Team member record ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
teams/create
{
"data": {
"team": {
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"user": {
"name": "Bob Lee",
"mail": "bob@example.com",
"mobile": {
"code": "91",
"number": "9000000002"
}
},
"role": "admin"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
201 Created
{
"data": {
"team": {
"name": "Acme Corp",
"nuvo": "1234567890123456",
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"user": {
"name": "Bob Lee",
"mail": "bob@example.com",
"mobile": {
"code": "91",
"number": "9000000002"
},
"nuvo": "9876543210987654",
"item": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
},
"sort": "user",
"role": "admin",
"menu": [],
"active": true,
"item": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"created": 1700000100000,
"modified": 1700000100000
},
"memo": "Team member added.",
"stat": true,
"code": 201,
"time": 1700000100012,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Team identifier required
{
"data": {},
"memo": "Team identifier required: data.team.item.",
"stat": false,
"code": 404,
"time": 1700000100034,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Already exists
{
"data": {},
"memo": "Team member already exists.",
"stat": false,
"code": 409,
"time": 1700000100056,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/teams/details
Fetch details for a team member record.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Team member record item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| team | object | no | { name, nuvo, item } |
| user | object | no | { name, mail, mobile, nuvo, item } |
| sort | string | no | Record sort |
| role | string | no | Member role |
| menu | array | no | Permission menu items |
| active | boolean | no | Active status |
| item | string | no | Team member record ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
teams/details
{
"data": {
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"team": {
"name": "Acme Corp",
"nuvo": "1234567890123456",
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"user": {
"name": "Bob Lee",
"mail": "bob@example.com",
"mobile": {
"code": "91",
"number": "9000000002"
},
"nuvo": "9876543210987654",
"item": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
},
"sort": "user",
"role": "admin",
"menu": [],
"active": true,
"item": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"created": 1700000100000,
"modified": 1700000100000
},
"memo": "Team member found.",
"stat": true,
"code": 200,
"time": 1700000200011,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Not found
{
"data": {},
"memo": "Team member not found.",
"stat": false,
"code": 404,
"time": 1700000200033,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/teams/list
Paginated list of team members for a team.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team (business) item ID |
| index | number | no | Page index (default: 1) |
| items | number | no | Per page (default: 10, max: 100) |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| team | object | no | { name, nuvo, item } |
| meta | object | no | { items, index, count } |
| list | array | no | Array of team member objects |
Request Payload
teams/list
{
"data": {
"team": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6",
"index": 1,
"items": 20
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"team": {
"name": "Acme Corp",
"nuvo": "1234567890123456",
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"meta": {
"items": 20,
"index": 1,
"count": 2
},
"list": [
{
"user": {
"name": "Bob Lee",
"mail": "bob@example.com",
"nuvo": "9876543210987654",
"item": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
},
"sort": "user",
"role": "admin",
"menu": [],
"active": true,
"item": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"created": 1700000100000
},
{
"user": {
"name": "Sara Chen",
"mail": "sara@example.com",
"nuvo": "1122334455667788",
"item": "c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8"
},
"sort": "user",
"role": "member",
"menu": [],
"active": true,
"item": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"created": 1700000200000
}
]
},
"memo": "Team members found.",
"stat": true,
"code": 200,
"time": 1700000300009,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Team identifier required
{
"data": {},
"memo": "Team identifier required: data.team.",
"stat": false,
"code": 404,
"time": 1700000300027,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/teams/delete
Soft-delete a team member record.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Team member record item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| team | object | no | { name, nuvo, item } |
| user | object | no | { name, nuvo, item } |
| active | boolean | no | false after deletion |
| item | string | no | Team member record ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
teams/delete
{
"data": {
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"team": {
"name": "Acme Corp",
"nuvo": "1234567890123456",
"item": "f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
},
"user": {
"name": "Bob Lee",
"nuvo": "9876543210987654",
"item": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"
},
"active": false,
"item": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"created": 1700000100000,
"modified": 1700000400000
},
"memo": "Team member removed.",
"stat": true,
"code": 200,
"time": 1700000400008,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Already inactive
{
"data": {},
"memo": "Team member already inactive.",
"stat": false,
"code": 409,
"time": 1700000400031,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}