GSMTasks Project API
The GSMtasks API is a RESTful web service for developers to programmatically interact with GSMtasks data, real-time delivery and task management and route optimization functionality.
- Homepage
- https://api.apis.guru/v2/specs/gsmtasks.com/2.4.13.json
- Provider
- gsmtasks.com
- OpenAPI version
- 3.0.3
- Spec (JSON)
- https://api.apis.guru/v2/specs/gsmtasks.com/2.4.13/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/gsmtasks.com/2.4.13/openapi.yaml
Tools (263)
Extracted live via the executor SDK.
-
accountRoles.accountRolesActivateCreatePOST /account_roles/{id}/activate/
-
accountRoles.accountRolesCreatePOST /account_roles/
-
accountRoles.accountRolesDestroyDELETE /account_roles/{id}/
-
accountRoles.accountRolesListGET /account_roles/
-
accountRoles.accountRolesNotifyCreatePOST /account_roles/{id}/notify/
-
accountRoles.accountRolesPartialUpdatePATCH /account_roles/{id}/
-
accountRoles.accountRolesRetrieveGET /account_roles/{id}/
-
accountRoles.accountRolesTokenRetrieveGET /account_roles/{id}/token/
-
accountRoles.accountRolesUpdatePUT /account_roles/{id}/
-
accounts.accountsBraintreeCustomerRetrieveGET /accounts/{id}/braintree_customer/
-
accounts.accountsChangeOwnerCreatePOST /accounts/{id}/change_owner/
-
accounts.accountsListGET /accounts/
-
accounts.accountsManagersCreatePOST /accounts/{id}/managers/
-
accounts.accountsManagersDestroyDELETE /accounts/{id}/managers/
-
accounts.accountsManagersRetrieveGET /accounts/{id}/managers/
-
accounts.accountsPartialUpdatePATCH /accounts/{id}/
-
accounts.accountsRetrieveGET /accounts/{id}/
-
accounts.accountsStripeAttachPaymentMethodUpdateAction 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
-
accounts.accountsStripeCreateSetupIntentCreateAction to start a new setup intent.
-
accounts.accountsStripeCreateSetupIntentUpdateAction to start a new setup intent.
-
accounts.accountsStripeDetachPaymentMethodUpdateDetached 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.accountsStripeGetPaymentMethodRetrieveFetch a single payment method from stripe. This will also return non-attached payment methods (from setup intents for example)
-
accounts.accountsStripeGetSetupAttemptRetrieveFetch a single setup intent
-
accounts.accountsStripeGetSetupIntentRetrieveFetch a single setup intent
-
accounts.accountsStripePaymentMethodsRetrieveFetch all customer payment methods. This includes all attached payment methods, default method_id
-
accounts.accountsStripeSetDefaultPaymentMethodUpdateAction to set a payment method to default.
-
accounts.accountsStripeSetupIntentsRetrieveFetch existing setup intents
-
accounts.accountsUpdatePUT /accounts/{id}/
-
accounts.accountsWorkersCreatePOST /accounts/{id}/workers/
-
accounts.accountsWorkersDestroyDELETE /accounts/{id}/workers/
-
accounts.accountsWorkersRetrieveGET /accounts/{id}/workers/
-
addons.addonsListGET /addons/
-
addons.addonsRetrieveGET /addons/{id}/
-
authenticate.authenticateCreatePOST /authenticate/
-
billing.billingCustomersClientTokenRetrieveGET /billing/customers/{id}/client_token/
-
billing.billingCustomersCreatePOST /billing/customers/
-
billing.billingCustomersListGET /billing/customers/
-
billing.billingCustomersPartialUpdatePATCH /billing/customers/{id}/
-
billing.billingCustomersRetrieveGET /billing/customers/{id}/
-
billing.billingCustomersUpdatePUT /billing/customers/{id}/
-
billing.billingInvoicesListGET /billing/invoices/
-
billing.billingInvoicesMarkAsPaidCreatePOST /billing/invoices/{id}/mark_as_paid/
-
billing.billingInvoicesPartialUpdatePATCH /billing/invoices/{id}/
-
billing.billingInvoicesRetrieveGET /billing/invoices/{id}/
-
billing.billingInvoicesUpdatePUT /billing/invoices/{id}/
-
billing.billingStripePaymentsListGET /billing/stripe_payments/
-
billing.billingStripePaymentsRetrieveGET /billing/stripe_payments/{id}/
-
billing.billingTransactionsListGET /billing/transactions/
-
billing.billingTransactionsRetrieveGET /billing/transactions/{id}/
-
clientRoles.clientRolesCreatePOST /client_roles/
-
clientRoles.clientRolesListGET /client_roles/
-
clientRoles.clientRolesNotifyCreatePOST /client_roles/{id}/notify/
-
clientRoles.clientRolesPartialUpdatePATCH /client_roles/{id}/
-
clientRoles.clientRolesRetrieveGET /client_roles/{id}/
-
clientRoles.clientRolesUpdatePUT /client_roles/{id}/
-
clients.clientsCreatePOST /clients/
-
clients.clientsListGET /clients/
-
clients.clientsPartialUpdatePATCH /clients/{id}/
-
clients.clientsRetrieveGET /clients/{id}/
-
clients.clientsUpdatePUT /clients/{id}/
-
configurations.configurationsListGET /configurations/
-
contactAddresses.contactAddressesCreatePOST /contact_addresses/
-
contactAddresses.contactAddressesListGET /contact_addresses/
-
contactAddresses.contactAddressesPartialUpdatePATCH /contact_addresses/{id}/
-
contactAddresses.contactAddressesRetrieveGET /contact_addresses/{id}/
-
contactAddresses.contactAddressesUpdatePUT /contact_addresses/{id}/
-
contactAddressExports.contactAddressExportsListThis view has multiple renderer classes available:
jsonandxlsx. In order to export the data as an excel file, just set query argumentformattoxlsx.When downloadingxlsxformat, use Accept headerapplication/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
-
contactAddressImport.contactAddressImportCreatePOST /contact_address_import/
-
contactAddressImport.contactAddressImportListGET /contact_address_import/
-
contactAddressImport.contactAddressImportRetrieveGET /contact_address_import/{id}/
-
devices.devicesCreatePOST /devices/
-
devices.devicesListGET /devices/
-
devices.devicesRetrieveGET /devices/{id}/
-
docs.docsSchemaRetrieveOpenApi3 schema for this API. Format can be selected via content negotiation.
- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json
-
documents.documentsBatchDeleteCreateAvailable from version 2.4.2
-
documents.documentsCreatePOST /documents/
-
documents.documentsDestroyDELETE /documents/{id}/
-
documents.documentsListGET /documents/
-
documents.documentsRetrieveGET /documents/{id}/
-
emails.emailsCreatePOST /emails/
-
emails.emailsDestroyDELETE /emails/{id}/
-
emails.emailsListGET /emails/
-
emails.emailsPartialUpdatePATCH /emails/{id}/
-
emails.emailsResendCreatePOST /emails/{id}/resend/
-
emails.emailsRetrieveGET /emails/{id}/
-
emails.emailsUpdatePUT /emails/{id}/
-
exports.exportsCreatePOST /exports/
-
exports.exportsDestroyDELETE /exports/{id}/
-
exports.exportsListGET /exports/
-
exports.exportsPartialUpdatePATCH /exports/{id}/
-
exports.exportsRetrieveGET /exports/{id}/
-
exports.exportsUpdatePUT /exports/{id}/
-
fileUploads.fileUploadsCreatePOST /file_uploads/
-
fileUploads.fileUploadsListGET /file_uploads/
-
fileUploads.fileUploadsRetrieveGET /file_uploads/{id}/
-
formrules.formrulesCreatePOST /formrules/
-
formrules.formrulesDestroyDELETE /formrules/{id}/
-
formrules.formrulesListGET /formrules/
-
formrules.formrulesPartialUpdatePATCH /formrules/{id}/
-
formrules.formrulesRetrieveGET /formrules/{id}/
-
formrules.formrulesUpdatePUT /formrules/{id}/
-
integrations.integrationsCreatePOST /integrations/
-
metafields.metafieldsCreatePOST /metafields/
-
metafields.metafieldsDestroyDELETE /metafields/{id}/
-
metafields.metafieldsListGET /metafields/
-
metafields.metafieldsPartialUpdatePATCH /metafields/{id}/
-
metafields.metafieldsRetrieveGET /metafields/{id}/
-
metafields.metafieldsUpdatePUT /metafields/{id}/
-
notifications.notificationsCreatePOST /notifications/
-
notifications.notificationsListGET /notifications/
-
notifications.notificationsRetrieveGET /notifications/{id}/
-
notificationTemplates.notificationTemplatesCreatePOST /notification_templates/
-
notificationTemplates.notificationTemplatesDestroyDELETE /notification_templates/{id}/
-
notificationTemplates.notificationTemplatesListGET /notification_templates/
-
notificationTemplates.notificationTemplatesPartialUpdatePATCH /notification_templates/{id}/
-
notificationTemplates.notificationTemplatesRenderCreatePOST /notification_templates/{id}/render/
-
notificationTemplates.notificationTemplatesRetrieveGET /notification_templates/{id}/
-
notificationTemplates.notificationTemplatesUpdatePUT /notification_templates/{id}/
-
orders.ordersCreatePOST /orders/
-
orders.ordersListGET /orders/
-
orders.ordersPartialUpdatePATCH /orders/{id}/
-
orders.ordersRetrieveGET /orders/{id}/
-
orders.ordersUpdatePUT /orders/{id}/
-
passwordChange.passwordChangeCreatePOST /password_change/
-
passwordReset.passwordResetCreatePOST /password_reset/
-
passwordResetConfirm.passwordResetConfirmCreatePOST /password_reset_confirm/
-
pushNotifications.pushNotificationsCreatePOST /push_notifications/
-
pushNotifications.pushNotificationsDestroyDELETE /push_notifications/{id}/
-
pushNotifications.pushNotificationsListGET /push_notifications/
-
pushNotifications.pushNotificationsPartialUpdatePATCH /push_notifications/{id}/
-
pushNotifications.pushNotificationsResendCreatePOST /push_notifications/{id}/resend/
-
pushNotifications.pushNotificationsRetrieveGET /push_notifications/{id}/
-
pushNotifications.pushNotificationsUpdatePUT /push_notifications/{id}/
-
recurrences.recurrencesCreatePOST /recurrences/
-
recurrences.recurrencesListGET /recurrences/
-
recurrences.recurrencesPartialUpdatePATCH /recurrences/{id}/
-
recurrences.recurrencesRetrieveGET /recurrences/{id}/
-
recurrences.recurrencesUpdatePUT /recurrences/{id}/
-
register.registerCreatePOST /register/
-
reports.reportsTasksStatesCountRetrieveGET /reports/tasks/states_count/
-
reviews.reviewsCreatePOST /reviews/
-
reviews.reviewsListGET /reviews/
-
reviews.reviewsRetrieveGET /reviews/{id}/
-
routeOptimizations.routeOptimizationsCommitCreatePOST /route_optimizations/{id}/commit/
-
routeOptimizations.routeOptimizationsCreatePOST /route_optimizations/
-
routeOptimizations.routeOptimizationsListGET /route_optimizations/
-
routeOptimizations.routeOptimizationsResultsRetrieveGET /route_optimizations/{id}/results/
-
routeOptimizations.routeOptimizationsRetrieveGET /route_optimizations/{id}/
-
routeOptimizations.routeOptimizationsRoutesCreatePOST /route_optimizations/{id}/routes/
-
routeOptimizations.routeOptimizationsRoutesRetrieveGET /route_optimizations/{id}/routes/
-
routeOptimizations.routeOptimizationsScheduleCreatePOST /route_optimizations/{id}/schedule/
-
routes.routesCreatePOST /routes/
-
routes.routesDestroyDELETE /routes/{id}/
-
routes.routesListGET /routes/
-
routes.routesPartialUpdatePATCH /routes/{id}/
-
routes.routesRetrieveGET /routes/{id}/
-
routes.routesUpdatePUT /routes/{id}/
-
scenes.scenesDashboardListGET /scenes/dashboard/
-
scenes.scenesOrderListListGET /scenes/order_list/
-
scenes.scenesRecurrenceListListGET /scenes/recurrence_list/
-
scenes.scenesTaskListListGET /scenes/task_list/
-
signatures.signaturesBatchDeleteCreateAvailable from version 2.4.2
-
signatures.signaturesCreatePOST /signatures/
-
signatures.signaturesDestroyDELETE /signatures/{id}/
-
signatures.signaturesListGET /signatures/
-
signatures.signaturesRetrieveGET /signatures/{id}/
-
sms.smsCreatePOST /sms/
-
sms.smsDestroyDELETE /sms/{id}/
-
sms.smsListGET /sms/
-
sms.smsPartialUpdatePATCH /sms/{id}/
-
sms.smsResendCreatePOST /sms/{id}/resend/
-
sms.smsRetrieveGET /sms/{id}/
-
sms.smsUpdatePUT /sms/{id}/
-
taskAddressFeatures.taskAddressFeaturesListGET /task_address_features/
-
taskAddressFeatures.taskAddressFeaturesRetrieveGET /task_address_features/{id}/
-
taskCommands.taskCommandsCreatePOST /task_commands/
-
taskCommands.taskCommandsListGET /task_commands/
-
taskCommands.taskCommandsRetrieveGET /task_commands/{id}/
-
taskCommands.taskCommandsUpdatePUT /task_commands/{id}/
-
taskEvents.taskEventsListMixin which allows the override of the filename being passed back to the user when the spreadsheet is downloaded.
-
taskEvents.taskEventsRetrieveMixin which allows the override of the filename being passed back to the user when the spreadsheet is downloaded.
-
taskEventTracks.taskEventTracksListGET /task_event_tracks/
-
taskEventTracks.taskEventTracksRetrieveGET /task_event_tracks/{id}/
-
taskExports.taskExportsListThis view has multiple renderer classes available:
jsonandxlsx. In order to export the data as an excel file, just set query argumentformattoxlsx.When downloadingxlsxformat, use Accept headerapplication/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 structuremetafields__{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'.
-
taskForms.taskFormsCreatePOST /task_forms/
-
taskForms.taskFormsDestroyDELETE /task_forms/{id}/
-
taskForms.taskFormsListGET /task_forms/
-
taskForms.taskFormsPartialUpdatePATCH /task_forms/{id}/
-
taskForms.taskFormsRetrieveGET /task_forms/{id}/
-
taskForms.taskFormsUpdatePUT /task_forms/{id}/
-
taskImport.taskImportCreatePOST /task_import/
-
taskImport.taskImportListGET /task_import/
-
taskImport.taskImportRetrieveGET /task_import/{id}/
-
taskImportMapping.taskImportMappingCreatePOST /task_import_mapping/
-
taskImportMapping.taskImportMappingListGET /task_import_mapping/
-
taskImportMapping.taskImportMappingRetrieveGET /task_import_mapping/{id}/
-
taskMetadatas.taskMetadatasListGET /task_metadatas/
-
taskMetadatas.taskMetadatasRetrieveGET /task_metadatas/{id}/
-
tasks.tasksAcceptCreatePOST /tasks/{id}/accept/
-
tasks.tasksAccountChangeCreatePOST /tasks/{id}/account_change/
-
tasks.tasksActivateCreatePOST /tasks/{id}/activate/
-
tasks.tasksAssignCreatePOST /tasks/{id}/assign/
-
tasks.tasksCancelCreatePOST /tasks/{id}/cancel/
-
tasks.tasksCompleteCreatePOST /tasks/{id}/complete/
-
tasks.tasksCreatePOST /tasks/
-
tasks.tasksDocumentsRetrieveGET /tasks/{id}/documents/
-
tasks.tasksEventsRetrieveGET /tasks/{id}/events/
-
tasks.tasksFailCreatePOST /tasks/{id}/fail/
-
tasks.tasksListGET /tasks/
-
tasks.tasksPartialUpdatePATCH /tasks/{id}/
-
tasks.tasksRejectCreatePOST /tasks/{id}/reject/
-
tasks.tasksReorderCreatePOST /tasks/reorder/
-
tasks.tasksRepositionCreatePOST /tasks/reposition/
-
tasks.tasksRetrieveGET /tasks/{id}/
-
tasks.tasksSignaturesRetrieveGET /tasks/{id}/signatures/
-
tasks.tasksTransitCreatePOST /tasks/{id}/transit/
-
tasks.tasksUnacceptCreatePOST /tasks/{id}/unaccept/
-
tasks.tasksUnassignCreatePOST /tasks/{id}/unassign/
-
tasks.tasksUpdatePUT /tasks/{id}/
-
timeLocationFeatures.timeLocationFeaturesCreatePOST /time_location_features/
-
timeLocationFeatures.timeLocationFeaturesDestroyDELETE /time_location_features/{id}/
-
timeLocationFeatures.timeLocationFeaturesListGET /time_location_features/
-
timeLocationFeatures.timeLocationFeaturesPartialUpdatePATCH /time_location_features/{id}/
-
timeLocationFeatures.timeLocationFeaturesRetrieveGET /time_location_features/{id}/
-
timeLocationFeatures.timeLocationFeaturesUpdatePUT /time_location_features/{id}/
-
timeLocations.timeLocationsCreatePOST /time_locations/
-
timeLocations.timeLocationsListGET /time_locations/
-
timeLocations.timeLocationsRetrieveGET /time_locations/{id}/
-
trackers.trackersCreatePOST /trackers/
-
trackers.trackersListGET /trackers/
-
trackers.trackersPartialUpdatePATCH /trackers/{id}/
-
trackers.trackersPublicRetrieveGET /trackers/{id}/public/
-
trackers.trackersRetrieveGET /trackers/{id}/
-
trackers.trackersUpdatePUT /trackers/{id}/
-
users.usersActivateCreatePOST /users/{id}/activate/
-
users.usersCreatePOST /users/
-
users.usersDestroyDELETE /users/{id}/
-
users.usersListGET /users/
-
users.usersOnDutyDestroyDELETE /users/{id}/on_duty/
-
users.usersOnDutyRetrieveGET /users/{id}/on_duty/
-
users.usersOnDutyUpdatePUT /users/{id}/on_duty/
-
users.usersPartialUpdatePATCH /users/{id}/
-
users.usersRetrieveGET /users/{id}/
-
users.usersUpdatePUT /users/{id}/
-
usersOnDutyLog.usersOnDutyLogCreatePOST /users_on_duty_log/
-
usersOnDutyLog.usersOnDutyLogListGET /users_on_duty_log/
-
usersOnDutyLog.usersOnDutyLogRetrieveGET /users_on_duty_log/{id}/
-
webhooks.webhooksActiveCreatePOST /webhooks/{id}/active/
-
webhooks.webhooksCreatePOST /webhooks/
-
webhooks.webhooksDestroyDELETE /webhooks/{id}/
-
webhooks.webhooksInactiveCreatePOST /webhooks/{id}/inactive/
-
webhooks.webhooksListGET /webhooks/
-
webhooks.webhooksPartialUpdatePATCH /webhooks/{id}/
-
webhooks.webhooksRetrieveGET /webhooks/{id}/
-
webhooks.webhooksUpdatePUT /webhooks/{id}/
-
workerFeatures.workerFeaturesListGET /worker_features/
-
workerFeatures.workerFeaturesRetrieveGET /worker_features/{user_id}/
-
workerTracks.workerTracksListGET /worker_tracks/
-
workingState.workingStateCreatePOST /working_state/
-
workingState.workingStateListGET /working_state/
-
workingState.workingStateRetrieveGET /working_state/{id}/
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools