Gsmtasks Project API

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

accounts

addons

authenticate

billing

client_roles

clients

configurations

contact_address_exports

contact_address_import

contact_addresses

devices

docs

documents

emails

exports

file_uploads

formrules

integrations

metafields

notification_templates

notifications

orders

password_change

password_reset

password_reset_confirm

push_notifications

recurrences

register

reports

reviews

route_optimizations

routes

scenes

signatures

sms

task_address_features

task_commands

task_event_tracks

task_events

task_exports

task_forms

task_import

task_import_mapping

task_metadatas

tasks

time_location_features

time_locations

trackers

users

users_on_duty_log

webhooks

worker_features

worker_tracks

working_state

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Search account_roles?" -> GET /account_roles/
• "Create a account_role?" -> POST /account_roles/
• "Get account_role details?" -> GET /account_roles/{id}/
• "Update a account_role?" -> PUT /account_roles/{id}/
• "Partially update a account_role?" -> PATCH /account_roles/{id}/
• "Delete a account_role?" -> DELETE /account_roles/{id}/
• "Create a activate?" -> POST /account_roles/{id}/activate/
• "Create a notify?" -> POST /account_roles/{id}/notify/
• "List all token?" -> GET /account_roles/{id}/token/
• "Search accounts?" -> GET /accounts/
• "Get account details?" -> GET /accounts/{id}/
• "Update a account?" -> PUT /accounts/{id}/
• "Partially update a account?" -> PATCH /accounts/{id}/
• "List all braintree_customer?" -> GET /accounts/{id}/braintree_customer/
• "Create a change_owner?" -> POST /accounts/{id}/change_owner/
• "List all managers?" -> GET /accounts/{id}/managers/
• "Create a manager?" -> POST /accounts/{id}/managers/
• "Create a stripe_create_setup_intent?" -> POST /accounts/{id}/stripe_create_setup_intent/
• "List all stripe_get_payment_method?" -> GET /accounts/{id}/stripe_get_payment_method/
• "List all stripe_get_setup_attempt?" -> GET /accounts/{id}/stripe_get_setup_attempt/
• "List all stripe_get_setup_intent?" -> GET /accounts/{id}/stripe_get_setup_intent/
• "List all stripe_payment_methods?" -> GET /accounts/{id}/stripe_payment_methods/
• "List all stripe_setup_intents?" -> GET /accounts/{id}/stripe_setup_intents/
• "List all workers?" -> GET /accounts/{id}/workers/
• "Create a worker?" -> POST /accounts/{id}/workers/
• "List all addons?" -> GET /addons/
• "Get addon details?" -> GET /addons/{id}/
• "Create a authenticate?" -> POST /authenticate/
• "List all customers?" -> GET /billing/customers/
• "Create a customer?" -> POST /billing/customers/
• "Get customer details?" -> GET /billing/customers/{id}/
• "Update a customer?" -> PUT /billing/customers/{id}/
• "Partially update a customer?" -> PATCH /billing/customers/{id}/
• "List all client_token?" -> GET /billing/customers/{id}/client_token/
• "List all invoices?" -> GET /billing/invoices/
• "Get invoice details?" -> GET /billing/invoices/{id}/
• "Update a invoice?" -> PUT /billing/invoices/{id}/
• "Partially update a invoice?" -> PATCH /billing/invoices/{id}/
• "Create a mark_as_paid?" -> POST /billing/invoices/{id}/mark_as_paid/
• "List all stripe_payments?" -> GET /billing/stripe_payments/
• "Get stripe_payment details?" -> GET /billing/stripe_payments/{id}/
• "List all transactions?" -> GET /billing/transactions/
• "Get transaction details?" -> GET /billing/transactions/{id}/
• "Search client_roles?" -> GET /client_roles/
• "Create a client_role?" -> POST /client_roles/
• "Get client_role details?" -> GET /client_roles/{id}/
• "Update a client_role?" -> PUT /client_roles/{id}/
• "Partially update a client_role?" -> PATCH /client_roles/{id}/
• "Create a notify?" -> POST /client_roles/{id}/notify/
• "Search clients?" -> GET /clients/
• "Create a client?" -> POST /clients/
• "Get client details?" -> GET /clients/{id}/
• "Update a client?" -> PUT /clients/{id}/
• "Partially update a client?" -> PATCH /clients/{id}/
• "List all configurations?" -> GET /configurations/
• "Search contact_address_exports?" -> GET /contact_address_exports/
• "List all contact_address_import?" -> GET /contact_address_import/
• "Create a contact_address_import?" -> POST /contact_address_import/
• "Get contact_address_import details?" -> GET /contact_address_import/{id}/
• "Search contact_addresses?" -> GET /contact_addresses/
• "Create a contact_address?" -> POST /contact_addresses/
• "Get contact_address details?" -> GET /contact_addresses/{id}/
• "Update a contact_address?" -> PUT /contact_addresses/{id}/
• "Partially update a contact_address?" -> PATCH /contact_addresses/{id}/
• "Search devices?" -> GET /devices/
• "Create a device?" -> POST /devices/
• "Get device details?" -> GET /devices/{id}/
• "List all schema?" -> GET /docs/schema/
• "Search documents?" -> GET /documents/
• "Create a document?" -> POST /documents/
• "Get document details?" -> GET /documents/{id}/
• "Delete a document?" -> DELETE /documents/{id}/
• "Create a batch_delete?" -> POST /documents/batch_delete/
• "Search emails?" -> GET /emails/
• "Create a email?" -> POST /emails/
• "Get email details?" -> GET /emails/{id}/
• "Update a email?" -> PUT /emails/{id}/
• "Partially update a email?" -> PATCH /emails/{id}/
• "Delete a email?" -> DELETE /emails/{id}/
• "Create a resend?" -> POST /emails/{id}/resend/
• "List all exports?" -> GET /exports/
• "Create a export?" -> POST /exports/
• "Get export details?" -> GET /exports/{id}/
• "Update a export?" -> PUT /exports/{id}/
• "Partially update a export?" -> PATCH /exports/{id}/
• "Delete a export?" -> DELETE /exports/{id}/
• "List all file_uploads?" -> GET /file_uploads/
• "Create a file_upload?" -> POST /file_uploads/
• "Get file_upload details?" -> GET /file_uploads/{id}/
• "Search formrules?" -> GET /formrules/
• "Create a formrule?" -> POST /formrules/
• "Get formrule details?" -> GET /formrules/{id}/
• "Update a formrule?" -> PUT /formrules/{id}/
• "Partially update a formrule?" -> PATCH /formrules/{id}/
• "Delete a formrule?" -> DELETE /formrules/{id}/
• "Create a integration?" -> POST /integrations/
• "Search metafields?" -> GET /metafields/
• "Create a metafield?" -> POST /metafields/
• "Get metafield details?" -> GET /metafields/{id}/
• "Update a metafield?" -> PUT /metafields/{id}/
• "Partially update a metafield?" -> PATCH /metafields/{id}/
• "Delete a metafield?" -> DELETE /metafields/{id}/
• "Search notification_templates?" -> GET /notification_templates/
• "Create a notification_template?" -> POST /notification_templates/
• "Get notification_template details?" -> GET /notification_templates/{id}/
• "Update a notification_template?" -> PUT /notification_templates/{id}/
• "Partially update a notification_template?" -> PATCH /notification_templates/{id}/
• "Delete a notification_template?" -> DELETE /notification_templates/{id}/
• "Create a render?" -> POST /notification_templates/{id}/render/
• "Search notifications?" -> GET /notifications/
• "Create a notification?" -> POST /notifications/
• "Get notification details?" -> GET /notifications/{id}/
• "Search orders?" -> GET /orders/
• "Create a order?" -> POST /orders/
• "Get order details?" -> GET /orders/{id}/
• "Update a order?" -> PUT /orders/{id}/
• "Partially update a order?" -> PATCH /orders/{id}/
• "Create a password_change?" -> POST /password_change/
• "Create a password_reset?" -> POST /password_reset/
• "Create a password_reset_confirm?" -> POST /password_reset_confirm/
• "Search push_notifications?" -> GET /push_notifications/
• "Create a push_notification?" -> POST /push_notifications/
• "Get push_notification details?" -> GET /push_notifications/{id}/
• "Update a push_notification?" -> PUT /push_notifications/{id}/
• "Partially update a push_notification?" -> PATCH /push_notifications/{id}/
• "Delete a push_notification?" -> DELETE /push_notifications/{id}/
• "Create a resend?" -> POST /push_notifications/{id}/resend/
• "Search recurrences?" -> GET /recurrences/
• "Create a recurrence?" -> POST /recurrences/
• "Get recurrence details?" -> GET /recurrences/{id}/
• "Update a recurrence?" -> PUT /recurrences/{id}/
• "Partially update a recurrence?" -> PATCH /recurrences/{id}/
• "Create a register?" -> POST /register/
• "List all states_count?" -> GET /reports/tasks/states_count/
• "List all reviews?" -> GET /reviews/
• "Create a review?" -> POST /reviews/
• "Get review details?" -> GET /reviews/{id}/
• "List all route_optimizations?" -> GET /route_optimizations/
• "Create a route_optimization?" -> POST /route_optimizations/
• "Get route_optimization details?" -> GET /route_optimizations/{id}/
• "Create a commit?" -> POST /route_optimizations/{id}/commit/
• "List all results?" -> GET /route_optimizations/{id}/results/
• "List all routes?" -> GET /route_optimizations/{id}/routes/
• "Create a route?" -> POST /route_optimizations/{id}/routes/
• "Create a schedule?" -> POST /route_optimizations/{id}/schedule/
• "List all routes?" -> GET /routes/
• "Create a route?" -> POST /routes/
• "Get route details?" -> GET /routes/{id}/
• "Update a route?" -> PUT /routes/{id}/
• "Partially update a route?" -> PATCH /routes/{id}/
• "Delete a route?" -> DELETE /routes/{id}/
• "Search dashboard?" -> GET /scenes/dashboard/
• "Search order_list?" -> GET /scenes/order_list/
• "Search recurrence_list?" -> GET /scenes/recurrence_list/
• "Search task_list?" -> GET /scenes/task_list/
• "Search signatures?" -> GET /signatures/
• "Create a signature?" -> POST /signatures/
• "Get signature details?" -> GET /signatures/{id}/
• "Delete a signature?" -> DELETE /signatures/{id}/
• "Create a batch_delete?" -> POST /signatures/batch_delete/
• "Search sms?" -> GET /sms/
• "Create a sm?" -> POST /sms/
• "Get sm details?" -> GET /sms/{id}/
• "Update a sm?" -> PUT /sms/{id}/
• "Partially update a sm?" -> PATCH /sms/{id}/
• "Delete a sm?" -> DELETE /sms/{id}/
• "Create a resend?" -> POST /sms/{id}/resend/
• "List all task_address_features?" -> GET /task_address_features/
• "Get task_address_feature details?" -> GET /task_address_features/{id}/
• "List all task_commands?" -> GET /task_commands/
• "Create a task_command?" -> POST /task_commands/
• "Get task_command details?" -> GET /task_commands/{id}/
• "Update a task_command?" -> PUT /task_commands/{id}/
• "List all task_event_tracks?" -> GET /task_event_tracks/
• "Get task_event_track details?" -> GET /task_event_tracks/{id}/
• "List all task_events?" -> GET /task_events/
• "Get task_event details?" -> GET /task_events/{id}/
• "Search task_exports?" -> GET /task_exports/
• "List all task_forms?" -> GET /task_forms/
• "Create a task_form?" -> POST /task_forms/
• "Get task_form details?" -> GET /task_forms/{id}/
• "Update a task_form?" -> PUT /task_forms/{id}/
• "Partially update a task_form?" -> PATCH /task_forms/{id}/
• "Delete a task_form?" -> DELETE /task_forms/{id}/
• "List all task_import?" -> GET /task_import/
• "Create a task_import?" -> POST /task_import/
• "Get task_import details?" -> GET /task_import/{id}/
• "List all task_import_mapping?" -> GET /task_import_mapping/
• "Create a task_import_mapping?" -> POST /task_import_mapping/
• "Get task_import_mapping details?" -> GET /task_import_mapping/{id}/
• "List all task_metadatas?" -> GET /task_metadatas/
• "Get task_metadata details?" -> GET /task_metadatas/{id}/
• "Search tasks?" -> GET /tasks/
• "Create a task?" -> POST /tasks/
• "Get task details?" -> GET /tasks/{id}/
• "Update a task?" -> PUT /tasks/{id}/
• "Partially update a task?" -> PATCH /tasks/{id}/
• "Create a accept?" -> POST /tasks/{id}/accept/
• "Create a account_change?" -> POST /tasks/{id}/account_change/
• "Create a activate?" -> POST /tasks/{id}/activate/
• "Create a assign?" -> POST /tasks/{id}/assign/
• "Create a cancel?" -> POST /tasks/{id}/cancel/
• "Create a complete?" -> POST /tasks/{id}/complete/
• "List all documents?" -> GET /tasks/{id}/documents/
• "List all events?" -> GET /tasks/{id}/events/
• "Create a fail?" -> POST /tasks/{id}/fail/
• "Create a reject?" -> POST /tasks/{id}/reject/
• "List all signatures?" -> GET /tasks/{id}/signatures/
• "Create a transit?" -> POST /tasks/{id}/transit/
• "Create a unaccept?" -> POST /tasks/{id}/unaccept/
• "Create a unassign?" -> POST /tasks/{id}/unassign/
• "Create a reorder?" -> POST /tasks/reorder/
• "Create a reposition?" -> POST /tasks/reposition/
• "List all time_location_features?" -> GET /time_location_features/
• "Create a time_location_feature?" -> POST /time_location_features/
• "Get time_location_feature details?" -> GET /time_location_features/{id}/
• "Update a time_location_feature?" -> PUT /time_location_features/{id}/
• "Partially update a time_location_feature?" -> PATCH /time_location_features/{id}/
• "Delete a time_location_feature?" -> DELETE /time_location_features/{id}/
• "List all time_locations?" -> GET /time_locations/
• "Create a time_location?" -> POST /time_locations/
• "Get time_location details?" -> GET /time_locations/{id}/
• "List all trackers?" -> GET /trackers/
• "Create a tracker?" -> POST /trackers/
• "Get tracker details?" -> GET /trackers/{id}/
• "Update a tracker?" -> PUT /trackers/{id}/
• "Partially update a tracker?" -> PATCH /trackers/{id}/
• "List all public?" -> GET /trackers/{id}/public/
• "Search users?" -> GET /users/
• "Create a user?" -> POST /users/
• "Get user details?" -> GET /users/{id}/
• "Update a user?" -> PUT /users/{id}/
• "Partially update a user?" -> PATCH /users/{id}/
• "Delete a user?" -> DELETE /users/{id}/
• "Create a activate?" -> POST /users/{id}/activate/
• "List all on_duty?" -> GET /users/{id}/on_duty/
• "List all users_on_duty_log?" -> GET /users_on_duty_log/
• "Create a users_on_duty_log?" -> POST /users_on_duty_log/
• "Get users_on_duty_log details?" -> GET /users_on_duty_log/{id}/
• "Search webhooks?" -> GET /webhooks/
• "Create a webhook?" -> POST /webhooks/
• "Get webhook details?" -> GET /webhooks/{id}/
• "Update a webhook?" -> PUT /webhooks/{id}/
• "Partially update a webhook?" -> PATCH /webhooks/{id}/
• "Delete a webhook?" -> DELETE /webhooks/{id}/
• "Create a active?" -> POST /webhooks/{id}/active/
• "Create a inactive?" -> POST /webhooks/{id}/inactive/
• "List all worker_features?" -> GET /worker_features/
• "Get worker_feature details?" -> GET /worker_features/{user_id}/
• "List all worker_tracks?" -> GET /worker_tracks/
• "List all working_state?" -> GET /working_state/
• "Create a working_state?" -> POST /working_state/
• "Get working_state details?" -> GET /working_state/{id}/
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP