## Endpoint: `/api/user/`
**Method**: `GET`
**Description**: Returns a list of users under the current tenant. This endpoint fetches either active or deactivated users based on the specified query parameters. It also supports filtering by username, email, and name, with pagination options.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| ---------- | ------- | -------- | ------------------------------------------------------------------------------------------------------ | ------------------ |
| `customer` | integer | No | Unique identifier for the customer | 99 |
| `active` | boolean | No | Filters users based on their status. Use `true` to get active users and `false` for deactivated users. | `true` |
| `email` | string | No | Filters users by their email address. Returns the user that matches the specified email. | `
[email protected]` |
| `limit` | integer | No | Limits the number of results returned per page. Useful for pagination. | `20` |
| `name` | string | No | Filters users by their full name. Returns the user that matches the specified name. | `John Doe` |
| `page` | integer | No | Specifies the page number for paginated results. Used in conjunction with the `limit` parameter. | `1` |
| `username` | string | No | Filters users by their username. Returns the user that matches the specified username. | `johndoe` |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"users": [
{
"username": "JohnDoe",
"first_name": "John",
"last_name": "Doe",
"email": "EmailAddress",
... USER DETAILS ...
}
],
}
### Notes
- Use the `active` parameter to filter between active and deactivated users.
- The `limit` and `page` parameters can be combined for efficient pagination.
- Filtering by `username`, `email`, or `name` is case-insensitive.
---
## Endpoint: `/api/user/{id}/`
**Method**: GET
**Description**: Retrieves the details of a specific user based on the provided ID.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique integer value identifying the user.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"username": "JohnDoe",
"first_name": "John",
"last_name": "Doe",
... USER DETAILS ...
},
}
---
## Endpoint: `/api/user/{id}/`
**Method**: PUT
**Description**: Updates relevant fields for a specific user based on the provided ID and payload.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique integer value identifying the user.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Payload
**Please Replace {VALUE} with the desired value**
{
"first_name": "FirstName",
"last_name": "LastName",
"email": "
[email protected]",
"phone": "+972 500000000",
"mobile": null,
"customer": null,
"active": true,
"department": null,
"username": "UserName",
"is_staff": false,
"is_superuser": false,
"color": "^#4caf50",
"teams": [],
"customer_id": "CustomerID",
"group_id": "GroupID",
"is_root_user": false
}
---
## Endpoint: `/api/user/{id}/`
**Method**: DELETE
**Description**: Deactivates the user by switching off the `is_active` flag. Once deactivated, the user is removed from their group.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique integer value identifying the user.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Request
`DELETE /api/user/{user_id}/`
### Example Response
`1
`This response means that the request has succeeded`
---
## Endpoint: `/api/user/{id}/edit_user/`
**Method**: POST
**Description**: **Edit specific user details based on the provided id.**
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique integer value identifying the user.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Payload
{
"id": {ID},
"first_name": "{FIRST_NAME}",
"last_name": "{LAST_NAME}",
"email": "{EMAILADDRESS}",
"phone": null,
"mobile": null,
"customer": 54,
"active": true,
"department": null,
"username": "{USERNAME}",
"is_staff": false,
"is_superuser": false,
"color": "#009688",
"teams": [],
"customer_id": {CUSTOMER_ID},
"group_id": {GROUP_ID},
"is_root_user": false,
"is_active": true
}
### Example Response
`200`
This response means that the request succeeded
---
## Endpoint: `/api/user/count/?active={true/false}`
**Method**: GET
**Description**: Returns an integer representing the count of users, filtered by their active or deactivated status.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`active`|boolean|No|`true` for active users and `false` for deactivated users.|`true`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"count": 1
}
---
## Endpoint: `/api/user/create_user/`
**Method**: POST
**Description**: Create a new user.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique integer value identifying the user.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Payload
{
"user_data": {
"username": "{USERNAME}",
"color": "#009688",
"first_name": "{FIRST_NAME}",
"last_name": "{LAST_NAME}",
"email": "{EMAIL_ADDRESS}",
"teams": []
},
"customer_id": {CUSTOMER_ID},
"group_id": "{GROUP_ID}"
}
### Example Response
`200`
This response means that the request succeeded
---
## Endpoint: `/api/teams/`
**Method**: GET
**Description**: Fetches all teams.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
| ------------- | -------- | ------------ | ---------------------------------- | ----------------- |
| customer | integer | No | Unique identifier for the customer | 99 |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
{
"id": Team_id,
"active": 1,
"name": "TeamName1",
... TEAM DETAILS ...
],
"users": [
{
"username": "JohnD",
"first_name": "John",
"last_name": "Doe",
... USER DETAILS ...
}
]
}
],
}
---
## Endpoint: `/api/teams/{team_id}`
**Method**: GET
**Description**: Fetches specific team by id.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|None|-|-|No parameters required.|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"id": Team_id,
"active": 1,
"name": "TeamName1",
... TEAM DETAILS ...
}
---
## Endpoint: `/api/teams/`
**Method**: POST
**Description**: Creates a new team.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|None|-|-|No parameters required.|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Payload
**Please Replace {VALUE} with the desired value**
{
"name": {TeamName},
"members": [
{id}
],
"color": {color},
"customer": {customer_id}
}
---
## Endpoint: `/api/teams/{id}/`
**Method**: PUT
**Description**: Updates details of a specific team based on the provided ID.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique identifier for the team.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Request
`PUT /api/teams/{group_id}/`
### Example Payload
{
"name": {new_value},
"color": {new_color_value},
"customer": "{customer_id}",
"members": []
}
### Example Response
`The details of the request (payload)
---
## Endpoint: `/api/teams/{id}/`
**Method**: DELETE
**Description**: Deletes a specific team based on the provided ID.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|`id`|integer|Yes|A unique identifier for the team.|`123`|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
`1`
`This response means that the request has succeeded`
---
## Endpoint: `/api/teams/count/`
**Method**: GET
**Description**: Retrieves the total count of teams.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|------------------|--------------------|
| None | - | - | No parameters required. | - |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"count": 1
}
---
## Endpoint: `/api/usersgroups/`
**Method:** GET
**Description:** Fetch all user groups.
### Parameters
|**Parameter**|**Type**|**Required**|**Description**|**Example Value**|
|---|---|---|---|---|
|None|-|-|No parameters required.|-|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"items": [
{
"id": {usergroup_id},
... USERSGROUP DETAILS ...
],
"users": [
{
"username": "JohnD",
... USER DETAILS ...
},
],
"permissions": [
{
"id": {admin_permission_id},
... PERMISSION DETAILS ...
}
],
"customer_name": "CustomerName"
},
],
}
---
## Endpoint: `/api/usersgroups/{id}/`
**Method:** GET
**Description:** Retrieve details of a specific user group by ID.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|------------------------------------------|-------------------|
| id | String | Yes | Unique identifier for the user group. | 12345 |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"id": {usergroup_id},
... USERSGROUP DETAILS ...
}
---
## Endpoint: `/api/usersgroups/{id}/`
**Method:** PUT
**Description:** Update details of a specific user group by ID.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|------------------------------------------|-------------------|
| id | String | Yes | Unique identifier for the user group. | 12345 |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Payload
**Please Replace {VALUE} with the desired value**
{
"name": "{new_name}",
"description": "{new_description}",
"active": {status},
"is_default": false,
"customer": {customer_id} ,
"app_modules": [15 , 16 ,17],
"customer_name": "{customer_name}"
}
---
## Endpoint: `/api/usersgroups/{id}/`
**Method:** DELETE
**Description:** Delete a specific user group by ID.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|------------------------------------------|-------------------|
| id | String | Yes | Unique identifier for the user group. | 12345 |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
`1`
`This response means that the request has succeeded`
---
## Endpoint: `/api/usersgroups/edit_group_permission/`
**Method:** POST
**Description:** Update permissions for a specific user group.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|--------------------------|-------------------|
| None | - | - | No parameters required. | - |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Payload
**Please Replace {VALUE} with the desired value**
{
"permissions": [
{
"id": "{permission_id}",
"name": "{permission_name}",
"newLevel": {newlevel_num},
"oldLevel": {oldlevel_num}
}
],
"grp_id": "{usergroup_id}"
}
### Example Response
`The details of the request (payload)
---
## Endpoint: `/api/usersgroups/get_groups_by_customer/`
**Method:** GET
**Description:** Fetch all user groups associated with a specific customer.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|--------------------------|-------------------|
| None | - | - | No parameters required. | - |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
[
{
"id": usergroup_id,
"name": "usergroup_name",
... USERSGROUP DETAILS ...
},
]
---
## Endpoint: `/api/usersgroups/get_groups_list/`
**Method:** GET
**Description:** Fetch the list of all groups.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|--------------------------|-------------------|
| None | - | - | No parameters required. | - |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"items": [
{
"id": {usergroup_id},
"name": "usergroup_id",
... USERGROUP DETAILS ...
"permissions": [
{
"id": {admin_permission_id},
... PERMISSION DETAILS ...
}
],
},
],
}
---
## Endpoint: `/api/usersgroups/get_list/`
**Method:** GET
**Description:** Retrieve the complete list of user groups.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|--------------------------|-------------------|
| None | - | - | No parameters required. | - |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Response
{
"items": [
{
"id": {usergroup_id},
... USERGROUP DETAILS ...
},
],
}
---
## Endpoint: `/api/customers-advanced/{id}/get_params/`
**Method:** GET
**Description:** Fetch advanced customer parameters.
### Parameters
| **Parameter** | **Type** | **Required** | **Description** | **Example Value** |
|---------------|----------|--------------|--------------------------------------|-------------------|
| id | String | Yes | Unique identifier for the customer. | 12345 |
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|`Authorization`|string|Yes|Bearer token for authentication|`Bearer <token>`|
### Example Request
`GET /api/customers-advanced/54/get_params/`
### Example Response
...FULL DETAILS ABOUT THE CUSTOMER...
---