GSMTasks Project API API

by gsmtasks.com

Overview

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.

GSMTasks Project API is a development API from gsmtasks.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 261 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Development
Version: 2.4.13
Endpoints: 261
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Endpoints

Method	Path	What it does
GET	`/account_roles/`	account_roles_list
POST	`/account_roles/`	account_roles_create
GET	`/account_roles/{id}/`	account_roles_retrieve
PUT	`/account_roles/{id}/`	account_roles_update
PATCH	`/account_roles/{id}/`	account_roles_partial_update
DELETE	`/account_roles/{id}/`	account_roles_destroy
POST	`/account_roles/{id}/activate/`	account_roles_activate_create
POST	`/account_roles/{id}/notify/`	account_roles_notify_create
GET	`/account_roles/{id}/token/`	account_roles_token_retrieve
GET	`/accounts/`	accounts_list
GET	`/accounts/{id}/`	accounts_retrieve
PUT	`/accounts/{id}/`	accounts_update
PATCH	`/accounts/{id}/`	accounts_partial_update
GET	`/accounts/{id}/braintree_customer/`	accounts_braintree_customer_retrieve
POST	`/accounts/{id}/change_owner/`	accounts_change_owner_create
GET	`/accounts/{id}/managers/`	accounts_managers_retrieve
POST	`/accounts/{id}/managers/`	accounts_managers_create
DELETE	`/accounts/{id}/managers/`	accounts_managers_destroy
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/`	accounts_workers_retrieve
POST	`/accounts/{id}/workers/`	accounts_workers_create
DELETE	`/accounts/{id}/workers/`	accounts_workers_destroy
GET	`/addons/`	addons_list
GET	`/addons/{id}/`	addons_retrieve
POST	`/authenticate/`	authenticate_create
GET	`/billing/customers/`	billing_customers_list
POST	`/billing/customers/`	billing_customers_create
GET	`/billing/customers/{id}/`	billing_customers_retrieve
PUT	`/billing/customers/{id}/`	billing_customers_update
PATCH	`/billing/customers/{id}/`	billing_customers_partial_update
GET	`/billing/customers/{id}/client_token/`	billing_customers_client_token_retrieve
GET	`/billing/invoices/`	billing_invoices_list
GET	`/billing/invoices/{id}/`	billing_invoices_retrieve
PUT	`/billing/invoices/{id}/`	billing_invoices_update
PATCH	`/billing/invoices/{id}/`	billing_invoices_partial_update
POST	`/billing/invoices/{id}/mark_as_paid/`	billing_invoices_mark_as_paid_create
GET	`/billing/stripe_payments/`	billing_stripe_payments_list
GET	`/billing/stripe_payments/{id}/`	billing_stripe_payments_retrieve
GET	`/billing/transactions/`	billing_transactions_list
GET	`/billing/transactions/{id}/`	billing_transactions_retrieve
GET	`/client_roles/`	client_roles_list
POST	`/client_roles/`	client_roles_create
GET	`/client_roles/{id}/`	client_roles_retrieve
PUT	`/client_roles/{id}/`	client_roles_update
PATCH	`/client_roles/{id}/`	client_roles_partial_update
POST	`/client_roles/{id}/notify/`	client_roles_notify_create
GET	`/clients/`	clients_list
POST	`/clients/`	clients_create
GET	`/clients/{id}/`	clients_retrieve
PUT	`/clients/{id}/`	clients_update
PATCH	`/clients/{id}/`	clients_partial_update
GET	`/configurations/`	configurations_list
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`.W
GET	`/contact_address_import/`	contact_address_import_list
POST	`/contact_address_import/`	contact_address_import_create
GET	`/contact_address_import/{id}/`	contact_address_import_retrieve
GET	`/contact_addresses/`	contact_addresses_list
POST	`/contact_addresses/`	contact_addresses_create
GET	`/contact_addresses/{id}/`	contact_addresses_retrieve
PUT	`/contact_addresses/{id}/`	contact_addresses_update
PATCH	`/contact_addresses/{id}/`	contact_addresses_partial_update
GET	`/devices/`	devices_list
POST	`/devices/`	devices_create
GET	`/devices/{id}/`	devices_retrieve
GET	`/docs/schema/`	OpenApi3 schema for this API. Format can be selected via content negotiation.
GET	`/documents/`	documents_list
POST	`/documents/`	documents_create
POST	`/documents/batch_delete/`	Available from version 2.4.2
GET	`/documents/{id}/`	documents_retrieve
DELETE	`/documents/{id}/`	documents_destroy
GET	`/emails/`	emails_list
POST	`/emails/`	emails_create
GET	`/emails/{id}/`	emails_retrieve
PUT	`/emails/{id}/`	emails_update
PATCH	`/emails/{id}/`	emails_partial_update
DELETE	`/emails/{id}/`	emails_destroy
POST	`/emails/{id}/resend/`	emails_resend_create
GET	`/exports/`	exports_list
POST	`/exports/`	exports_create
GET	`/exports/{id}/`	exports_retrieve
PUT	`/exports/{id}/`	exports_update
PATCH	`/exports/{id}/`	exports_partial_update
DELETE	`/exports/{id}/`	exports_destroy
GET	`/file_uploads/`	file_uploads_list
POST	`/file_uploads/`	file_uploads_create
GET	`/file_uploads/{id}/`	file_uploads_retrieve
GET	`/formrules/`	formrules_list
POST	`/formrules/`	formrules_create
GET	`/formrules/{id}/`	formrules_retrieve
PUT	`/formrules/{id}/`	formrules_update
PATCH	`/formrules/{id}/`	formrules_partial_update