Skip to main content
GET
/
api
/
v2
/
workspaces
/
{workspaceId}
/
tickets
/
search
Search tickets
curl --request GET \
  --url https://api.example.com/api/v2/workspaces/{workspaceId}/tickets/search
{
  "data": [
    {
      "autotaskTicket": {
        "id": 123,
        "companyId": 123,
        "projectId": 123,
        "assignedResourceId": 123,
        "assignedResourceRoleId": 123,
        "billingCodeId": 123,
        "categoryId": 123,
        "number": "<string>",
        "type": 123,
        "title": "<string>",
        "description": "<string>",
        "priority": "High",
        "status": 123,
        "queueId": 123,
        "dueDateTime": "2023-11-07T05:31:56Z",
        "notes": [
          {
            "id": 123,
            "description": "<string>",
            "ticketId": 123,
            "title": "<string>"
          }
        ]
      },
      "serviceNowTicket": {
        "id": "<string>",
        "description": "<string>",
        "shortDescription": "<string>",
        "number": "<string>",
        "state": "New",
        "urgency": "High",
        "comments": [
          {
            "sysId": "<string>",
            "elementId": "<string>",
            "value": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "createdBy": "<string>",
            "element": "<string>"
          }
        ]
      },
      "jiraTicket": {
        "id": "<string>",
        "description": "<string>",
        "summary": "<string>",
        "number": "<string>",
        "currentStatus": {
          "id": "<string>",
          "name": "<string>"
        },
        "priority": {
          "id": "<string>",
          "name": "<string>"
        },
        "assignee": {
          "accountId": "<string>",
          "displayName": "<string>",
          "active": true
        },
        "project": {
          "id": "<string>",
          "name": "<string>",
          "key": "<string>"
        },
        "issueType": {
          "id": "<string>",
          "name": "<string>",
          "projectId": "<string>",
          "subtask": true
        },
        "requestType": {
          "id": "<string>",
          "name": "<string>"
        },
        "labels": [
          "<string>"
        ],
        "availablePriorities": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "availableStatuses": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      },
      "ticketingSystemType": "Autotask",
      "isTicketSet": true
    }
  ],
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.contraforce.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

workspaceId
string<uuid>
required

Query Parameters

groupingId
string
ticketNumber
string

Response

OK

Standard v2 API response envelope for single-item responses.

data
null | object[]
meta
object