Skip to main content
GET
/
v1
/
tickets
cURL
curl --request GET \
  --url https://platform.thena.ai/v1/tickets \
  --header 'x-api-key: <api-key>'
{
  "status": true,
  "message": "Success",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "id": "<string>",
      "ticketIdentifier": "<string>",
      "title": "<string>",
      "ticketId": 123,
      "description": "<string>",
      "source": "<string>",
      "accountId": "<string>",
      "status": "<string>",
      "statusId": "<string>",
      "priority": "<string>",
      "priorityId": "<string>",
      "storyPoints": 123,
      "account": "<string>",
      "teamId": "<string>",
      "teamName": "<string>",
      "teamIdentifier": "<string>",
      "subTeamId": "<string>",
      "subTeamName": "<string>",
      "subTeamIdentifier": "<string>",
      "isPrivate": true,
      "typeId": "<string>",
      "type": "<string>",
      "assignedAgent": "<string>",
      "assignedAgentId": "<string>",
      "assignedAgentEmail": "<string>",
      "assignedAgentAvatar": "<string>",
      "requestorEmail": "<string>",
      "customerContactId": "<string>",
      "customerContactFirstName": "<string>",
      "customerContactLastName": "<string>",
      "customerContactEmail": "<string>",
      "submitterEmail": "<string>",
      "customFieldValues": [
        "<string>"
      ],
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "formId": "<string>",
      "aiGeneratedTitle": "<string>",
      "aiGeneratedSummary": "<string>",
      "sentiment": "<string>",
      "sentimentId": "<string>",
      "teamIcon": "<string>",
      "teamColor": "<string>",
      "teamOrganizationId": "<string>",
      "teamParentTeamId": "<string>",
      "teamDescription": "<string>",
      "teamConfigurationId": "<string>",
      "teamTeamOwnerId": "<string>",
      "teamIsActive": true,
      "teamIsPrivate": true,
      "teamCreatedAt": "<string>",
      "teamUpdatedAt": "<string>",
      "teamDeletedAt": "<string>",
      "teamArchivedAt": "<string>",
      "subTeamIcon": "<string>",
      "subTeamColor": "<string>",
      "subTeamOrganizationId": "<string>",
      "subTeamParentTeamId": "<string>",
      "subTeamDescription": "<string>",
      "subTeamConfigurationId": "<string>",
      "subTeamTeamOwnerId": "<string>",
      "subTeamIsActive": true,
      "subTeamIsPrivate": true,
      "subTeamCreatedAt": "<string>",
      "subTeamUpdatedAt": "<string>",
      "subTeamDeletedAt": "<string>",
      "subTeamArchivedAt": "<string>",
      "lastCustomerComment": "<string>",
      "lastVendorComment": "<string>",
      "lastComment": "<string>",
      "isEscalated": true,
      "closedAt": "<string>",
      "closedBy": "<string>",
      "closedById": "<string>",
      "closedByEmail": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Enter your API key

Query Parameters

​
teamId
string

The ID of the team to filter tickets by

Example:

"T00M677SAK"

​
dateRange
enum<string>

Calendar-based range in UTC. Examples: 1d = since 00:00 UTC yesterday, 2d = since 00:00 UTC 2 days ago, 1w = since 00:00 UTC 7 days ago, 3m = since 00:00 UTC on the same date 3 months ago.

Available options:
1d,
2d,
1w,
2w,
3w,
4w,
1m,
3m
​
page
number
default:0

The page number to fetch tickets by

Required range: x >= 0
Example:

0

​
limit
number
default:10

The limit number of tickets to fetch

Required range: 1 <= x <= 100
Example:

10

Response

Operation successful

​
status
boolean
default:true
required

The status of the response

​
message
string
default:Success
required

The message of the response

​
timestamp
string<date-time>
default:2024-01-01T00:00:00.000Z
required

The timestamp of the response

​
data
object[]
required

The tickets fetched