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 OpenAPI v3 definition below.

Create a new ticket

post

Authorizations

AuthorizationstringRequired

Use the Authorization header with the value Api-Token <your-token>. The token is assigned to a user.

Body

descriptionstringRequired

A detailed description of the ticket.

Example: User has lost access to his account.

prioritystringOptional

The priority of the ticket.

Example: CRITICAL

statusstringOptional

The current status of the ticket.

Example: Open

assigneestring | nullableOptional

The user Slack member ID assigned to the ticket.

Example: U132FRJPTER

requesterstringOptional

The requester Slack member ID of the ticket.

Example: U073PBJPHGW

requesterChannelstringRequired

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

Example: C012K1Y23L4

tagsstring[] | nullableOptional

Tags associated with the ticket.

Example: bug

formIdstringRequired

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

Responses

201

Ticket successfully created

application/json

400

Invalid request payload

404

Ticket not found

500

Server error

post

/ticket

POST /ticket HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "description": "User has lost access to his account.",
  "priority": "CRITICAL",
  "status": "Open",
  "assignee": "U132FRJPTER",
  "requester": "U073PBJPHGW",
  "customFields": [
    {
      "fieldId": "9682a666-b6b2-4f5e-833d-cb4430799317",
      "value": "High Business Impact"
    }
  ],
  "requesterChannel": "C012K1Y23L4",
  "tags": [
    "bug"
  ],
  "formId": "96d140f8-bd0f-4b46-a115-c19e090bb79c"
}

{
  "ticketId": "758e6b65-b4ec-4a03-a15a-9d44ac88e093"
}

Get a ticket by ticket number

get

Retrieve ticket details by ticket number.

Rate Limiting: This endpoint is rate limited to prevent abuse. Default limits are:

100 requests per 15 minutes per API token

Rate limit information is returned in response headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset).

Authorizations

AuthorizationstringRequired

Use the Authorization header with the value Bearer <jwt-token>. The JWT token contains user and team information.

Path parameters

ticketNumberintegerRequired

The numeric ticket number (e.g., 2075).

Example: 2075

Responses

200

Ticket successfully retrieved

application/json

400

Invalid ticket number (must be numeric)

application/json

401

Unauthorized - Invalid or missing authentication token

application/json

403

Access denied - Ticket belongs to a different team

application/json

404

Ticket not found

application/json

429

Too many requests - Rate limit exceeded

application/json

500

Server error

application/json

get

/ticket/{ticketNumber}

GET /ticket/{ticketNumber} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "758e6b65-b4ec-4a03-a15a-9d44ac88e093",
  "ticketNumber": 2075,
  "teamId": "T01234ABCDE",
  "queueId": "6f8d19d9-f181-4688-9926-5278cb824b3c",
  "formId": "96d140f8-bd0f-4b46-a115-c19e090bb79c",
  "status": "Open",
  "priority": "CRITICAL",
  "description": "User has lost access to his account.",
  "assignee": "U132FRJPTER",
  "requesterId": "U073PBJPHGW",
  "requester": "John Doe",
  "tags": [
    "bug",
    "urgent"
  ],
  "customFields": [
    {
      "fieldName": "Impact",
      "value": "High Business Impact"
    },
    {
      "fieldName": "Department",
      "value": "Engineering"
    }
  ],
  "createdAt": "2025-10-15T10:30:00.000Z",
  "updatedAt": "2025-10-28T08:45:00.000Z",
  "closedDate": null,
  "organization": "Acme Corp",
  "source": "slack",
  "archived": false,
  "messageRequesterChannel": "C012K1Y23L4",
  "messageResponderChannel": "C023K4Y75L6",
  "responderThreadPermalink": "https://workspace.slack.com/archives/C023K4Y75L6/p1234567890",
  "requesterThreadPermalink": "https://workspace.slack.com/archives/C012K1Y23L4/p1234567890",
  "summaryTitle": "Account Access Issue",
  "summaryProblem": "User unable to log in to account",
  "summarySolution": "Reset password and verified access",
  "csatRating": 5,
  "csatComment": "Great support, issue resolved quickly!",
  "externalTicketRefs": [
    "JIRA-123"
  ]
}

Delete a ticket

delete

Authorizations

AuthorizationstringRequired

Use the Authorization header with the value Api-Token <your-token>. The token is assigned to a user.

Path parameters

ticketIdstringRequired

The UUID of the ticket to delete.

Example: 758e6b65-b4ec-4a03-a15a-9d44ac88e093

Responses

200

Ticket successfully deleted

No content

404

Ticket not found

500

Server error

delete

/ticket/{ticketId}

DELETE /ticket/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update an existing ticket

patch

Authorizations

AuthorizationstringRequired

Use the Authorization header with the value Api-Token <your-token>. The token is assigned to a user.

Path parameters

ticketIdobjectRequired

The unique ID of the ticket to update.

Body

anyOptional

Responses

200

Ticket successfully updated

No content

400

Invalid request payload

404

Ticket not found

500

Server error

patch

/ticket/{ticketId}

PATCH /ticket/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "description": "Updated issue details.",
  "priority": "Medium",
  "status": "Closed",
  "assignee": "U132FRJPTER",
  "requester": "U073PBJPHGW",
  "customFields": [
    {
      "fieldId": "9682a666-b6b2-4f5e-833d-cb4430799317",
      "value": "High Business Impact"
    }
  ],
  "requesterChannel": "C012K1Y23L4",
  "tags": [
    "bug"
  ]
}

No content

Create or associate an external ticket

post

Authorizations

AuthorizationstringRequired

Use the Authorization header with the value Api-Token <your-token>. The token is assigned to a user.

Path parameters

ticketIdobjectRequired

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

Body

externalIdstringOptional

The ID of the external ticket.

Example: EXT-123

integrationTypestringOptional

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

Example: Jira

urlstring · uriOptional

The URL of the external ticket.

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

Responses

201

External ticket successfully associated

application/json

400

Invalid request payload

404

Ticket not found

500

Server error

post

/ticket/external/{ticketId}

POST /ticket/external/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "externalId": "EXT-123",
  "integrationType": "Jira",
  "url": "https://jira.example.com/browse/EXT-123",
  "data": {
    "team_ref": "H34211",
    "crm_id": "ID42298"
  }
}

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

Post a new reply to a ticket

post

Authorizations

AuthorizationstringRequired

Use the Authorization header with the value Api-Token <your-token>. The token is assigned to a user.

Path parameters

ticketIdobjectRequired

The unique UUID of the Suptask ticket.

Body

textstringOptional

The reply message text

Example: We are working on your ticket.

usernamestringOptional

The displayed username of the reply text.

Example: Greg McDonald

channelarrayOptional

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

Example: ["requester", "responder"]

Responses

200

Returns

application/json

400

Invalid request payload

404

Suptask ticket not found

500

Server error

post

/ticket/reply/{ticketId}

POST /ticket/reply/{ticketId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "text": "We are working on your ticket.",
  "username": "Greg McDonald",
  "channel": "[\"requester\", \"responder\"]"
}

{
  "success": true,
  "message": "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.

How to retrieve values for the API

Retrieve the Form ID

Retrieve the Form ID by opening up the Form from your Inbox and edit it. From the URL you can get the Form ID which is in a UUID format:

Retrieve the field ID

Every created field in your Suptask account have a unique ID that can be retrieved from the Manage fields page by editing the field. The field ID is in a UUID format and be retried from the URL:

Retrieve the user Slack member ID

Retrieve the Slack member ID of a user.

PreviousGoogle Sheets NextWebHooks

Last updated 1 month ago

Was this helpful?

hashtagOverview

hashtagAPI Definition

hashtagCreate a new ticket

hashtagGet a ticket by ticket number

hashtagDelete a ticket

hashtagUpdate an existing ticket

hashtagCreate or associate an external ticket

hashtagPost a new reply to a ticket

hashtagRequest API access

hashtagHow to retrieve values for the API

hashtagRetrieve the Form ID

hashtagRetrieve the field ID

hashtagRetrieve the user Slack member ID

Overview

API Definition

Create a new ticket

Get a ticket by ticket number

Delete a ticket

Update an existing ticket

Create or associate an external ticket

Post a new reply to a ticket

Request API access

How to retrieve values for the API

Retrieve the Form ID

Retrieve the field ID

Retrieve the user Slack member ID