## Endpoint: `/api/customer-actions/`
**Method**: GET
**Description**: Fetch a list of all actions that can be executed on events per customer (including integrations).
### 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|
### Example Response
{
"results": [
{
"id": 61,
"action": {
"id": 1,
"name": "snooze",
... ACTION DETAILS ...
},
... CUSTOMER DETAILS ...
}
],
}
---
## Endpoint: `/api/customer-actions/{id}/`
**Method**: GET
**Description**: Fetch a specific action of a customer by using its ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|id|string|Yes|Unique identifier for the customer action|12345|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
`...MORE DETAILED RESPONSE OF THE ACTION..`
---
## Endpoint: `/api/todo-list/`
**Method**: GET
**Description**: Fetch the list of proactives.
### 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|
### Example Response
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": <Proactive_id>,
"customer": <Customer_id>,
"user": {
"username": "<User_name>",
"first_name": "",
"last_name": "",
...**MORE DETAILS OF THE PROACTIVE**..
}
}
],
}
---
## Endpoint: `/api/todo-list/{id}/`
**Method**: GET
**Description**: Fetch a specific proactive by ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|id|string|Yes|Unique identifier for the proactive task|12345|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
`...MORE DETAILED RESPONSE OF THE ACTION..`
---
## Endpoint: `/api/todo-list/{id}/retrieve_for_task/`
**Method**: GET
**Description**: Retrieve all the information regarding a specific proactive by ID.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|id|string|Yes|Unique identifier for the proactive task|12345|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
{
"id": customer_id,
"user": null,
"actions": [
{
"id": 4818,
"action": {
"id": 4,
"customer": 2,
"action": {
"id": 1,
"name": "snooze",
...**ACTION DETAILS**...
}
}
],
}
---
## Endpoint: `/api/todo-list/all_ids_and_names/?customer={id}`
**Method**: GET
**Description**: Retrieve all IDs and names of Guidelines.
### Parameters
|Parameter|Type|Required|Description|Example Value|
|---|---|---|---|---|
|customer|string|Yes|Unique identifier for the customer|54|
### Headers
|Header|Type|Required|Description|Example Value|
|---|---|---|---|---|
|Authorization|string|Yes|Bearer token for authentication|Bearer|
### Example Response
[
{
"id": <Guideline_id1>,
"name": "<Guideline_name1>"
},
{
"id": <Guideline_id2>,
"name": "<Guideline_name2>"
}
]
---
## Endpoint: `/api/todo-list/count/`
**Method**: GET
**Description**: Retrieve the total count of Guidelines.
### 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|
### Example Response
{
"count": <Count_number>
}
---
## Endpoint: `/api/todo/meta/`
**Method**: GET
**Description**: Retrieve the metadata for all the actions in the system.
### 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|
### Example Response
{
"customer_actions": [
{
"id": 61,
"action": {
"id": 1,
"cls": "Snooze",
"category": "snooze",
...**ACTION DETAILS**...
},
],
}
---