gsmtasks-project-api — quality + safety report

---
name: gsmtasks-project-api
description: "GSMTasks Project API skill. Use when working with GSMTasks Project for account_roles, accounts, addons. Covers 261 endpoints."
version: 1.0.0
generator: lapsh
---

# GSMTasks Project API
API version: 2.4.13

## Auth
ApiKey Authorization in header

## Base URL
Not specified.

## Setup
1. Set your API key in the appropriate header
2. GET /account_roles/ -- verify access
3. POST /account_roles/ -- create first account_roles

## Endpoints

261 endpoints across 55 groups. See references/api-spec.lap for full details.

### account_roles
| Method | Path | Description |
|--------|------|-------------|
| GET | /account_roles/ |  |
| POST | /account_roles/ |  |
| GET | /account_roles/{id}/ |  |
| PUT | /account_roles/{id}/ |  |
| PATCH | /account_roles/{id}/ |  |
| DELETE | /account_roles/{id}/ |  |
| POST | /account_roles/{id}/activate/ |  |
| POST | /account_roles/{id}/notify/ |  |
| GET | /account_roles/{id}/token/ |  |

### accounts
| Method | Path | Description |
|--------|------|-------------|
| GET | /accounts/ |  |
| GET | /accounts/{id}/ |  |
| PUT | /accounts/{id}/ |  |
| PATCH | /accounts/{id}/ |  |
| GET | /accounts/{id}/braintree_customer/ |  |
| POST | /accounts/{id}/change_owner/ |  |
| GET | /accounts/{id}/managers/ |  |
| POST | /accounts/{id}/managers/ |  |
| DELETE | /accounts/{id}/managers/ |  |
| PUT | /accounts/{id}/stripe_attach_payment_method/ | Action to (re)set the account stripe customer and payment method to new values. |
| POST | /accounts/{id}/stripe_create_setup_intent/ | Action to start a new setup intent. |
| PUT | /accounts/{id}/stripe_create_setup_intent/ | Action to start a new setup intent. |
| PUT | /accounts/{id}/stripe_detach_payment_method/ | Detached payment method from the customer. |
| GET | /accounts/{id}/stripe_get_payment_method/ | Fetch a single payment method from stripe. |
| GET | /accounts/{id}/stripe_get_setup_attempt/ | Fetch a single setup intent |
| GET | /accounts/{id}/stripe_get_setup_intent/ | Fetch a single setup intent |
| GET | /accounts/{id}/stripe_payment_methods/ | Fetch all customer payment methods. |
| PUT | /accounts/{id}/stripe_set_default_payment_method/ | Action to set a payment method to default. |
| GET | /accounts/{id}/stripe_setup_intents/ | Fetch existing setup intents |
| GET | /accounts/{id}/workers/ |  |
| POST | /accounts/{id}/workers/ |  |
| DELETE | /accounts/{id}/workers/ |  |

### addons
| Method | Path | Description |
|--------|------|-------------|
| GET | /addons/ |  |
| GET | /addons/{id}/ |  |

### authenticate
| Method | Path | Description |
|--------|------|-------------|
| POST | /authenticate/ |  |

### billing
| Method | Path | Description |
|--------|------|-------------|
| GET | /billing/customers/ |  |
| POST | /billing/customers/ |  |
| GET | /billing/customers/{id}/ |  |
| PUT | /billing/customers/{id}/ |  |
| PATCH | /billing/customers/{id}/ |  |
| GET | /billing/customers/{id}/client_token/ |  |
| GET | /billing/invoices/ |  |
| GET | /billing/invoices/{id}/ |  |
| PUT | /billing/invoices/{id}/ |  |
| PATCH | /billing/invoices/{id}/ |  |
| POST | /billing/invoices/{id}/mark_as_paid/ |  |
| GET | /billing/stripe_payments/ |  |
| GET | /billing/stripe_payments/{id}/ |  |
| GET | /billing/transactions/ |  |
| GET | /billing/transactions/{id}/ |  |

### client_roles
| Method | Path | Description |
|--------|------|-------------|
| GET | /client_roles/ |  |
| POST | /client_roles/ |  |
| GET | /client_roles/{id}/ |  |
| PUT | /client_roles/{id}/ |  |
| PATCH | /client_roles/{id}/ |  |
| POST | /client_roles/{id}/notify/ |  |

### clients
| Method | Path | Description |
|--------|------|-------------|
| GET | /clients/ |  |
| POST | /clients/ |  |
| GET | /clients/{id}/ |  |
| PUT | /clients/{id}/ |  |
| PATCH | /clients/{id}/ |  |

### configurations
| Method | Path | Description |
|--------|------|-------------|
| GET | /configurations/ |  |

### contact_address_exports
| Method | Path | Description |
|--------|------|-------------|
| GET | /contact_address_exports/ | This view has multiple renderer classes available: `json` and `xlsx`. In order to export the data as an excel file, just set query argument `format` to `xlsx`.When downloading `xlsx` format, use Accept header `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=...` |

### contact_address_import
| Method | Path | Description |
|--------|------|-------------|
| GET | /contact_address_import/ |  |
| POST | /contact_address_import/ |  |
| GET | /contact_address_import/{id}/ |  |

### contact_addresses
| Method | Path | Description |
|--------|------|-------------|
| GET | /contact_addresses/ |  |
| POST | /contact_addresses/ |  |
| GET | /contact_addresses/{id}/ |  |
| PUT | /contact_addresses/{id}/ |  |
| PATCH | /contact_addresses/{id}/ |  |

### devices
| Method | Path | Description |
|--------|------|-------------|
| GET | /devices/ |  |
| POST | /devices/ |  |
| GET | /devices/{id}/ |  |

### docs
| Method | Path | Description |
|--------|------|-------------|
| GET | /docs/schema/ | OpenApi3 schema for this API. Format can be selected via content negotiation. |

### documents
| Method | Path | Description |
|--------|------|-------------|
| GET | /documents/ |  |
| POST | /documents/ |  |
| GET | /documents/{id}/ |  |
| DELETE | /documents/{id}/ |  |
| POST | /documents/batch_delete/ | Available from version 2.4.2 |

### emails
| Method | Path | Description |
|--------|------|-------------|
| GET | /emails/ |  |
| POST | /emails/ |  |
| GET | /emails/{id}/ |  |
| PUT | /emails/{id}/ |  |
| PATCH | /emails/{id}/ |  |
| DELETE | /emails/{id}/ |  |
| POST | /emails/{id}/resend/ |  |

### exports
| Method | Path | Description |
|--------|------|-------------|
| GET | /exports/ |  |
| POST | /exports/ |  |
| GET | /exports/{id}/ |  |
| PUT | /exports/{id}/ |  |
| PATCH | /exports/{id}/ |  |
| DELETE | /exports/{id}/ |  |

### file_uploads
| Method | Path | Description |
|--------|------|-------------|
| GET | /file_uploads/ |  |
| POST | /file_uploads/ |  |
| GET | /file_uploads/{id}/ |  |

### formrules
| Method | Path | Description |
|--------|------|-------------|
| GET | /formrules/ |  |
| POST | /formrules/ |  |
| GET | /formrules/{id}/ |  |
| PUT | /formrules/{id}/ |  |
| PATCH | /formrules/{id}/ |  |
| DELETE | /formrules/{id}/ |  |

### integrations
| Method | Path | Description |
|--------|------|-------------|
| POST | /integrations/ |  |

### metafields
| Method | Path | Description |
|--------|------|-------------|
| GET | /metafields/ |  |
| POST | /metafields/ |  |
| GET | /metafields/{id}/ |  |
| PUT | /metafields/{id}/ |  |
| PATCH | /metafields/{id}/ |  |
| DELETE | /metafields/{id}/ |  |

### notification_templates
| Method | Path | Description |
|--------|------|-------------|
| GET | /notification_templates/ |  |
| POST | /notification_templates/ |  |
| GET | /notification_templates/{id}/ |  |
| PUT | /notification_templates/{id}/ |  |
| PATCH | /notification_templates/{id}/ |  |
| DELETE | /notification_templates/{id}/ |  |
| POST | /notification_templates/{id}/render/ |  |

### notifications
| Method | Path | Description |
|--------|------|-------------|
| GET | /notifications/ |  |
| POST | /notifications/ |  |
| GET | /notifications/{id}/ |  |

### orders
| Method | Path | Description |
|--------|------|-------------|
| GET | /orders/ |  |
| POST | /orders/ |  |
| GET | /orders/{id}/ |  |
| PUT | /orders/{id}/ |  |
| PATCH | /orders/{id}/ |  |

### password_change
| Method | Path | Description |
|--------|------|-------------|
| POST | /password_change/ |  |

### password_reset
| Method | Path | Description |
|--------|------|-------------|
| POST | /password_reset/ |  |

### password_reset_confirm
| Method | Path | Description |
|--------|------|-------------|
| POST | /password_reset_confirm/ |  |

### push_notifications
| Method | Path | Description |
|--------|------|-------------|
| GET | /push_notifications/ |  |
| POST | /push_notifications/ |  |
| GET | /push_notifications/{id}/ |  |
| PUT | /push_notifications/{id}/ |  |
| PATCH | /push_notifications/{id}/ |  |
| DELETE | /push_notifications/{id}/ |  |
| POST | /push_notifications/{id}/resend/ |  |

### recurrences
| Method | Path | Description |
|--------|------|-------------|
| GET | /recurrences/ |  |
| POST | /recurrences/ |  |
| GET | /recurrences/{id}/ |  |
| PUT | /recurrences/{id}/ |  |
| PATCH | /recurrences/{id}/ |  |

### register
| Method | Path | Description |
|--------|------|-------------|
| POST | /register/ |  |

### reports
| Method | Path | Description |
|--------|------|-------------|
| GET | /reports/tasks/states_count/ |  |

### reviews
| Method | Path | Description |
|--------|------|-------------|
| GET | /reviews/ |  |
| POST | /reviews/ |  |
| GET | /reviews/{id}/ |  |

### route_optimizations
| Method | Path | Description |
|--------|------|-------------|
| GET | /route_optimizations/ |  |
| POST | /route_optimizations/ |  |
| GET | /route_optimizations/{id}/ |  |
| POST | /route_optimizations/{id}/commit/ |  |
| GET | /route_optimizations/{id}/results/ |  |
| GET | /route_optimizations/{id}/routes/ |  |
| POST | /route_optimizations/{id}/routes/ |  |
| POST | /route_optimizations/{id}/schedule/ |  |

### routes
| Method | Path | Description |
|--------|------|-------------|
| GET | /routes/ |  |
| POST | /routes/ |  |
| GET | /routes/{id}/ |  |
| PUT | /routes/{id}/ |  |
| PATCH | /routes/{id}/ |  |
| DELETE | /routes/{id}/ |  |

### scenes
| Method | Path | Description |
|--------|------|-------------|
| GET | /scenes/dashboard/ |  |
| GET | /scenes/order_list/ |  |
| GET | /scenes/recurrence_list/ |  |
| GET | /scenes/task_list/ |  |

### signatures
| Method | Path | Description |
|--------|------|-------------|
| GET | /signatures/ |  |
| POST | /signatures/ |  |
| GET | /signatures/{id}/ |  |
| DELETE | /signatures/{id}/ |  |
| POST | /signatures/batch_delete/ | Available from version 2.4.2 |

### sms
| Method | Path | Description |
|--------|------|-------------|
| GET | /sms/ |  |
| POST | /sms/ |  |
| GET | /sms/{id}/ |  |
| PUT | /sms/{id}/ |  |
| PATCH | /sms/{id}/ |  |
| DELETE | /sms/{id}/ |  |
| POST | /sms/{id}/resend/ |  |

### task_address_features
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_address_features/ |  |
| GET | /task_address_features/{id}/ |  |

### task_commands
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_commands/ |  |
| POST | /task_commands/ |  |
| GET | /task_commands/{id}/ |  |
| PUT | /task_commands/{id}/ |  |

### task_event_tracks
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_event_tracks/ |  |
| GET | /task_event_tracks/{id}/ |  |

### task_events
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_events/ | Mixin which allows the override of the filename being |
| GET | /task_events/{id}/ | Mixin which allows the override of the filename being |

### task_exports
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_exports/ | This view has multiple renderer classes available: `json` and `xlsx`. In order to export the data as an excel file, just set query argument `format` to `xlsx`.When downloading `xlsx` format, use Accept header `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=...` |

### task_forms
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_forms/ |  |
| POST | /task_forms/ |  |
| GET | /task_forms/{id}/ |  |
| PUT | /task_forms/{id}/ |  |
| PATCH | /task_forms/{id}/ |  |
| DELETE | /task_forms/{id}/ |  |

### task_import
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_import/ |  |
| POST | /task_import/ |  |
| GET | /task_import/{id}/ |  |

### task_import_mapping
| Method | Path | Description |
|--------|------|-------------|
| GET | /task_import_mapping/ |  |
| POST

… (truncated)