Spoki

https://support.spoki.com/en/docs
Admin
Spoki is a platform that helps businesses develop their operations using WhatsApp for marketing,...
Tokens:59,636
Snippets:610
Trust Score:6.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### Automation and Ticket Management API

Source: https://support.spoki.com/en/docs/integrations/get-started-with-spoki-mcp

APIs for managing automations and support tickets.

```APIDOC
## GET /api/automations/{automation_id}

### Description
Gets details of a specific automation by its ID.

### Method
GET

### Endpoint
/api/automations/{automation_id}

### Parameters
#### Path Parameters
- **automation_id** (string) - Required - The unique identifier of the automation.

### Response
#### Success Response (200)
- **automation_details** (object) - Contains the details of the automation.

#### Response Example
```json
{
  "automation_details": {
    "id": "a54321",
    "name": "Welcome Series"
  }
}
```

## GET /api/automations/{automation_id}/steps

### Description
Gets the steps of a specific automation by its ID.

### Method
GET

### Endpoint
/api/automations/{automation_id}/steps

### Parameters
#### Path Parameters
- **automation_id** (string) - Required - The unique identifier of the automation.

### Response
#### Success Response (200)
- **steps** (array) - A list of steps within the automation.

#### Response Example
```json
{
  "steps": [
    {
      "step_number": 1,
      "action": "send_email"
    }
  ]
}
```

## GET /api/automations

### Description
Lists all automations for the configured Spoki account with optional filtering.

### Method
GET

### Endpoint
/api/automations

### Parameters
#### Query Parameters
- **filter** (object) - Optional - Criteria to filter automations.

### Response
#### Success Response (200)
- **automations** (array) - A list of automation objects.

#### Response Example
```json
[
  {
    "id": "a54321",
    "name": "Welcome Series"
  }
]
```

## POST /api/tickets

### Description
Creates a new support ticket.

### Method
POST

### Endpoint
/api/tickets

### Parameters
#### Request Body
- **subject** (string) - Required - The subject of the support ticket.
- **description** (string) - Required - The detailed description of the issue.
- **priority** (string) - Optional - The priority of the ticket (e.g., 'low', 'medium', 'high').

### Request Example
```json
{
  "subject": "Login Issue",
  "description": "User cannot log in to their account.",
  "priority": "high"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **ticket_id** (string) - The ID of the newly created ticket.

#### Response Example
```json
{
  "status": "success",
  "ticket_id": "t10101"
}
```

## GET /api/tickets

### Description
Lists support tickets with filtering options.

### Method
GET

### Endpoint
/api/tickets

### Parameters
#### Query Parameters
- **filter** (object) - Optional - Criteria to filter tickets.

### Response
#### Success Response (200)
- **tickets** (array) - A list of support ticket objects.

#### Response Example
```json
[
  {
    "id": "t10101",
    "subject": "Login Issue",
    "status": "open"
  }
]
```

```

--------------------------------

### Reporting and Account Management API

Source: https://support.spoki.com/en/docs/integrations/get-started-with-spoki-mcp

APIs for retrieving account reports and listing accounts.

```APIDOC
## GET /api/accounts/report

### Description
Gets the current usage report for an account.

### Method
GET

### Endpoint
/api/accounts/report

### Response
#### Success Response (200)
- **report_data** (object) - Contains the usage report data.

#### Response Example
```json
{
  "report_data": {
    "usage_percentage": 75,
    "contacts_count": 10000
  }
}
```

## GET /api/accounts

### Description
Lists all accounts accessible to the user.

### Method
GET

### Endpoint
/api/accounts

### Response
#### Success Response (200)
- **accounts** (array) - A list of account objects.

#### Response Example
```json
[
  {
    "id": "acc987",
    "name": "Main Account"
  }
]
```

```

--------------------------------

### Template and List Operations API

Source: https://support.spoki.com/en/docs/integrations/get-started-with-spoki-mcp

APIs for managing message templates and listing contact lists.

```APIDOC
## GET /api/templates

### Description
Lists all available message templates.

### Method
GET

### Endpoint
/api/templates

### Response
#### Success Response (200)
- **templates** (array) - A list of message template objects.

#### Response Example
```json
[
  {
    "id": "tpl001",
    "name": "Welcome Email"
  }
]
```

## GET /api/contact_lists

### Description
Lists all contact lists associated with contacts.

### Method
GET

### Endpoint
/api/contact_lists

### Response
#### Success Response (200)
- **contact_lists** (array) - A list of contact list objects.

#### Response Example
```json
[
  {
    "id": "cl5555",
    "name": "Newsletter Subscribers"
  }
]
```

```

--------------------------------

### Report Listing API

Source: https://support.spoki.com/en/docs/integrations/get-started-with-spoki-mcp

API for listing all available reports with optional filtering and sorting.

```APIDOC
## GET /api/reports

### Description
Lists all reports with optional filtering and sorting.

### Method
GET

### Endpoint
/api/reports

### Parameters
#### Query Parameters
- **filter** (object) - Optional - Criteria to filter reports.
- **sort** (string) - Optional - Field to sort the reports by.

### Response
#### Success Response (200)
- **reports** (array) - A list of report objects.

#### Response Example
```json
[
  {
    "id": "r1111",
    "name": "Monthly Sales Report",
    "created_at": "2023-10-26T10:00:00Z"
  }
]
```

```
Tokens:
Raw