GSMTasks Project API
The GSMTasks API provides endpoints for managing delivery routes (e.g., updating a route by its UUID) and for retrieving detailed task or scene data through a dashboard endpoint that supports extensive filtering on addresses, assignees, timestamps, barcodes, and other task attributes.
Latency
3883ms p95
Uptime
100.0% 30d
Playground
Verified
live
Endpoints
/routes/{id}/
/routes/{id}/
/scenes/dashboard/
/users/{id}/
/users/{id}/
/users/{id}/activate/
/users/{id}/on_duty/
/users/{id}/on_duty/
/users/{id}/on_duty/
/account_roles/{id}/notify/
/account_roles/{id}/token/
/accounts/{id}/change_owner/
/accounts/{id}/managers/
/accounts/{id}/managers/
/accounts/{id}/managers/
/billing/customers/{id}/client_token/
/clients/{id}/
/clients/{id}/
/configurations/
/file_uploads/{id}/
/route_optimizations/{id}/routes/
/route_optimizations/{id}/routes/
/route_optimizations/{id}/schedule/
/task_forms/{id}/
/task_forms/{id}/
/task_forms/{id}/
/users/
/accounts/
/accounts/{id}/
/users/
/accounts/{id}/
/accounts/{id}/
/accounts/{id}/braintree_customer/
/account_roles/{id}/
/account_roles/{id}/
/account_roles/{id}/
/account_roles/{id}/activate/
/account_roles/
/account_roles/
/account_roles/{id}/
/accounts/{id}/stripe_attach_payment_method/
Action to (re)set the account stripe customer and payment method to new values. By default the attached method will also be set as default. If this is not desired, you can send 'set_default': False
/accounts/{id}/stripe_create_setup_intent/
Action to start a new setup intent.
/accounts/{id}/stripe_create_setup_intent/
Action to start a new setup intent.
/accounts/{id}/stripe_detach_payment_method/
Detached payment method from the customer. The payment method itself will remain somewhere in stripe, but as its no longer linked to the customer, it might as well be deleted for us
/accounts/{id}/stripe_get_payment_method/
Fetch a single payment method from stripe. This will also return non-attached payment methods (from setup intents for example)
/accounts/{id}/stripe_get_setup_attempt/
Fetch a single setup intent
/accounts/{id}/stripe_get_setup_intent/
Fetch a single setup intent
/accounts/{id}/stripe_payment_methods/
Fetch all customer payment methods. This includes all attached payment methods, default method_id
/accounts/{id}/stripe_set_default_payment_method/
Action to set a payment method to default.
/accounts/{id}/stripe_setup_intents/
Fetch existing setup intents
/accounts/{id}/workers/
/accounts/{id}/workers/
/accounts/{id}/workers/
/addons/
/addons/{id}/
/authenticate/
/billing/customers/
/billing/customers/
/billing/customers/{id}/
/billing/customers/{id}/
/billing/customers/{id}/
/billing/invoices/
/billing/invoices/{id}/
/billing/invoices/{id}/
/billing/invoices/{id}/
/billing/invoices/{id}/mark_as_paid/
/billing/stripe_payments/
/billing/stripe_payments/{id}/
/billing/transactions/
/billing/transactions/{id}/
/client_roles/
/client_roles/
/client_roles/{id}/
/client_roles/{id}/
/client_roles/{id}/
/client_roles/{id}/notify/
/clients/
/clients/
/clients/{id}/
/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=...` The user can request what fields and in what order will be rendered using query argument `fields`. This is a comma separated list of field names used in the API. When exporting to **excel**, the column names may be changed based on pre-defined field names and width mapping. Available since version 2.2.1
/contact_address_import/
/contact_address_import/
/contact_address_import/{id}/
/contact_addresses/
/contact_addresses/
/contact_addresses/{id}/
/contact_addresses/{id}/
/contact_addresses/{id}/
/devices/
/devices/
/devices/{id}/
/docs/schema/
OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
/documents/
/documents/
/documents/batch_delete/
Available from version 2.4.2
/documents/{id}/
/documents/{id}/
/emails/
/emails/
/emails/{id}/
/emails/{id}/
/emails/{id}/
/emails/{id}/
/emails/{id}/resend/
/exports/
/exports/
/exports/{id}/
/exports/{id}/
/exports/{id}/
/exports/{id}/
/file_uploads/
/file_uploads/
/formrules/
/formrules/
/formrules/{id}/
/formrules/{id}/
/formrules/{id}/
/formrules/{id}/
/integrations/
/metafields/
/metafields/
/metafields/{id}/
/metafields/{id}/
/metafields/{id}/
/metafields/{id}/
/notification_templates/
/notification_templates/
/notification_templates/{id}/
/notification_templates/{id}/
/notification_templates/{id}/
/notification_templates/{id}/
/notification_templates/{id}/render/
/users/{id}/
/notifications/
/notifications/
/notifications/{id}/
/orders/
/orders/
/orders/{id}/
/orders/{id}/
/orders/{id}/
/password_change/
/password_reset/
/password_reset_confirm/
/push_notifications/
/push_notifications/
/push_notifications/{id}/
/push_notifications/{id}/
/push_notifications/{id}/
/push_notifications/{id}/
/push_notifications/{id}/resend/
/routes/
/routes/
/routes/{id}/
/routes/{id}/
/recurrences/
/recurrences/
/recurrences/{id}/
/recurrences/{id}/
/recurrences/{id}/
/register/
/reports/tasks/states_count/
/reviews/
/reviews/
/reviews/{id}/
/route_optimizations/
/route_optimizations/
/route_optimizations/{id}/
/route_optimizations/{id}/commit/
/route_optimizations/{id}/results/
/scenes/order_list/
/scenes/recurrence_list/
/scenes/task_list/
/signatures/
/signatures/
/signatures/batch_delete/
Available from version 2.4.2
/signatures/{id}/
/signatures/{id}/
/sms/
/sms/
/sms/{id}/
/sms/{id}/
/sms/{id}/
/sms/{id}/
/sms/{id}/resend/
/users/{id}/
/task_address_features/
/task_address_features/{id}/
/task_commands/
/task_commands/
/task_commands/{id}/
/task_commands/{id}/
/task_event_tracks/
/task_event_tracks/{id}/
/task_events/
Mixin which allows the override of the filename being passed back to the user when the spreadsheet is downloaded.
/task_events/{id}/
Mixin which allows the override of the filename being passed back to the user when the spreadsheet is downloaded.
/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=...` The user can request what fields and in what order will be rendered using query argument `fields`. This is a comma separated list of field names used in the API. Available fields are visible in the example. Also metafields can be added to the response. For this just add them as fields, using structure `metafields__{metafield.namespace}:{metafield.key}`. When exporting to **excel**, the column names may be changed based on account metafield names or pre-defined field name and width mapping. Changes in version 2.2.1: * field names have been updated to reflect the Task fields schema and filters. * Invalid fields in fields request will return a ValidationError. * Account filter is required. * AccountRole display name is annotated to user objects. * 'task_event_notes' is dropped. * 'contact_phone' and 'contact_email' is replaced with 'contact_phones' and 'contact_emails'.
/task_forms/
/task_forms/
/task_forms/{id}/
/task_import/
/task_import/
/task_import/{id}/
/task_import_mapping/
/task_import_mapping/
/task_import_mapping/{id}/
/task_metadatas/
/task_metadatas/{id}/
/tasks/
/tasks/
/tasks/reorder/
/tasks/reposition/
/tasks/{id}/
/tasks/{id}/
/tasks/{id}/
/tasks/{id}/accept/
/tasks/{id}/account_change/
/tasks/{id}/activate/
/tasks/{id}/assign/
/tasks/{id}/cancel/
/tasks/{id}/complete/
/tasks/{id}/documents/
/tasks/{id}/events/
/tasks/{id}/fail/
/tasks/{id}/reject/
/tasks/{id}/signatures/
/tasks/{id}/transit/
/tasks/{id}/unaccept/
/tasks/{id}/unassign/
/time_location_features/
/time_location_features/
/time_location_features/{id}/
/time_location_features/{id}/
/time_location_features/{id}/
/time_location_features/{id}/
/time_locations/
/time_locations/
/time_locations/{id}/
/trackers/
/trackers/
/trackers/{id}/
/trackers/{id}/
/trackers/{id}/
/trackers/{id}/public/
/users_on_duty_log/
/users_on_duty_log/
/users_on_duty_log/{id}/
/webhooks/
/webhooks/
/webhooks/{id}/
/webhooks/{id}/
/webhooks/{id}/
/webhooks/{id}/
/webhooks/{id}/active/
/webhooks/{id}/inactive/
/worker_features/
/worker_features/{user_id}/
/worker_tracks/
/working_state/
/working_state/
/working_state/{id}/
261 endpoints auto-detected
Authentication
This API uses an API key, passed in the "Authorization" header. No OAuth required.
curl -X PATCH \
"https://gsmtasks.com/routes/{id}/" \
-H "Authorization: YOUR_API_KEY"gsmtasks.com · HTTPS only