Suptask API

Learn how to use and integrate with the Suptask API

Overview

Suptask offers an open API that enables you to integrate programmatically and automate your ticketing process.

API Definition

Review the API definition in the Openapi v3. See the attached YAML file below.

10KB

suptask_public_api_openapi-1.1.3.yaml

Create a new ticket

post

/ticket

Authorizations

Body

descriptionstring

A detailed description of the ticket.

Example: User has lost access to his account.

prioritystring | nullable

The priority of the ticket.

Example: CRITICAL

statusstring

The current status of the ticket.

Example: Open

assigneestring | nullable

The user Slack member ID assigned to the ticket.

Example: U132FRJPTER

requesterstring

The requester Slack member ID of the ticket.

Example: U073PBJPHGW

requesterChannelstring

One of the Slack channel IDs which are assigned to form.

Example: C076K6Y74L1

formIdstring

Identifier UUID for the form used to submit the ticket. Fetched from the Web url when editing a form.

Example: 96d140f8-bd0f-4b46-a115-c19e090bb79c

customFieldsobject[]

Custom fields for the ticket.

tagsstring[] | nullable

Tags associated with the ticket.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/ticket' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"description":"User has lost access to his account.","priority":"CRITICAL","status":"Open","assignee":"U132FRJPTER","requester":"U073PBJPHGW","requesterChannel":"C076K6Y74L1","formId":"96d140f8-bd0f-4b46-a115-c19e090bb79c","customFields":[{"name":"Operating System","value":"Windows 11"}],"tags":["bug"]}'

201

400

201

{
  "ticketId": "123"
}

Ticket successfully created

Update an existing ticket

patch

/ticket/{ticketId}

Authorizations

Path parameters

ticketIdstringrequired

The unique ID of the ticket to update.

Example: 123

Body

descriptionstring

A detailed description of the ticket.

Example: Updated issue details.

prioritystring | nullable

The priority of the ticket.

Example: Medium

statusstring

The current status of the ticket.

Example: Closed

assigneestring | nullable

The user Slack member ID assigned to the ticket.

Example: U132FRJPTER

requesterstring

The requester Slack member ID of the ticket.

Example: U073PBJPHGW

requesterChannelstring

One of the Slack channel IDs which are assigned to form.

Example: C076K6Y74L1

customFieldsobject[]

Custom fields for the ticket.

tagsstring[] | nullable

Tags associated with the ticket.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/ticket/{ticketId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"description":"Updated issue details.","priority":"Medium","status":"Closed","assignee":"U132FRJPTER","requester":"U073PBJPHGW","requesterChannel":"C076K6Y74L1","customFields":[{"name":"Operating System","value":"Windows 11"}],"tags":["bug"]}'

200

400

404

200

No body

Ticket successfully updated

Delete a ticket

delete

/ticket/{ticketId}

Authorizations

Path parameters

ticketIdstringrequired

The unique ID of the ticket to delete.

Example: ticket123

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/ticket/{ticketId}' \
  --header 'Authorization: YOUR_API_KEY'

200

404

500

200

No body

Ticket successfully deleted

Create or associate an external ticket

post

/ticket/external/{ticketId}

Authorizations

Path parameters

ticketIdstringrequired

The unique ID of the Suptask ticket to associate with an external ticket.

Example: 123

Body

externalIdstring

The ID of the external ticket.

Example: EXT-123

integrationTypestring

The type of integration (e.g., "Jira", "Zendesk").

Example: Jira

urlstring · uri

The URL of the external ticket.

Example: https://jira.example.com/browse/EXT-123

dataobject

Additional data or metadata for the external ticket.

Example: {"priority":"High","status":"Open"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/ticket/external/{ticketId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"externalId":"EXT-123","integrationType":"Jira","url":"https://jira.example.com/browse/EXT-123","data":{"priority":"High","status":"Open"}}'

201

400

404

500

201

{
  "success": true,
  "message": "External ticket associated successfully."
}

External ticket successfully associated

Post a new reply

post

/ticket/reply/{ticketId}

Authorizations

Path parameters

ticketIdstringrequired

The unique ID of the Suptask ticket.

Example: 123

Body

messagestring

The reply message

Example: We are working on your ticket.

prioritystring | nullable

The priority of the ticket.

Example: CRITICAL

channelstring

Select between Requester (public reply) or Responder (internal reply) channel.

Example: Requester

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/ticket/reply/{ticketId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"message":"We are working on your ticket.","priority":"CRITICAL","channel":"Requester"}'

201

400

404

500

201

{
  "success": true,
  "message": "Reply message sent successfully"
}

Reply message sent successfully

---

Request API access

The API requires a valid API token in order to authenticate to the API.

Contact Suptask Support to retrieve your access token and get started with the API.

---

Other parsers

You can use the Swagger Editor in order to visualize the API definition.

1. Click on File

2. Click on Import File

3. Select the Suptask API definition (.yaml)