Skip to main content
API docs by Redocly

Tickets API (v1.1.0)

Managing tickets, comments, and ticket topics in the Control panel

Tickets

Tickets namespace

Create ticket

Authorizations:
X-Token
Request Body schema: application/json
files
Array of strings <uuid> (File) [ 1 .. 10 ] items [ items <uuid > ]
client_aliased_name
string non-empty
client_emails
Array of strings <email> non-empty [ items <email > ]
comment_body
required
string [ 1 .. 50000 ] characters
summary
required
string [ 1 .. 255 ] characters
topic_key
string non-empty

Responses

Request samples

Content type
application/json
{
  • "comment_body": "my first comment",
  • "summary": "new test ticket"
}

Response samples

Content type
application/json
{
  • "client_aliased_name": "string",
  • "client_emails": [
    ],
  • "closed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_client_author": true,
  • "is_client_read": true,
  • "is_closed": true,
  • "is_resolved": true,
  • "number": 0,
  • "splitted_from_ticket_number": 0,
  • "status": {
    },
  • "summary": "string",
  • "type": null,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vote": {
    }
}

Returns all tickets

Authorizations:
X-Token
query Parameters
only_opened
boolean
page
integer <int32> >= 1
Default: 1
only_closed
boolean
q
string non-empty

search query

items_per_page
integer <int32> [ 1 .. 1000 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "item_count": 0,
  • "items": [
    ],
  • "items_per_page": 0,
  • "page": 0,
  • "page_count": 0
}

Find ticket by number

Authorizations:
X-Token
path Parameters
ticket_number
required
integer

Responses

Response samples

Content type
application/json
{
  • "client_aliased_name": "string",
  • "client_emails": [
    ],
  • "closed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_client_author": true,
  • "is_client_read": true,
  • "is_closed": true,
  • "is_resolved": true,
  • "number": 0,
  • "splitted_from_ticket_number": 0,
  • "status": {
    },
  • "summary": "string",
  • "type": null,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vote": {
    }
}

Modify ticket properties

Authorizations:
X-Token
path Parameters
ticket_number
required
integer
Request Body schema: application/json
client_aliased_name
string or null non-empty
client_emails
Array of strings <email> [ items <email > ]

Responses

Request samples

Content type
application/json
{
  • "client_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "client_aliased_name": "string",
  • "client_emails": [
    ],
  • "closed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_client_author": true,
  • "is_client_read": true,
  • "is_closed": true,
  • "is_resolved": true,
  • "number": 0,
  • "splitted_from_ticket_number": 0,
  • "status": {
    },
  • "summary": "string",
  • "type": null,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vote": {
    }
}

Close ticket

Authorizations:
X-Token
path Parameters
ticket_number
required
integer
Request Body schema: application/json
comment
string non-empty
score
integer <int32> [ 1 .. 10 ]

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "score": 1
}

Response samples

Content type
application/json
{
  • "client_aliased_name": "string",
  • "client_emails": [
    ],
  • "closed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_client_author": true,
  • "is_client_read": true,
  • "is_closed": true,
  • "is_resolved": true,
  • "number": 0,
  • "splitted_from_ticket_number": 0,
  • "status": {
    },
  • "summary": "string",
  • "type": null,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vote": {
    }
}

Reopen ticket

Authorizations:
X-Token
path Parameters
ticket_number
required
integer
Request Body schema: application/json
files
Array of strings <uuid> (File) [ 1 .. 10 ] items [ items <uuid > ]
body
required
string [ 1 .. 50000 ] characters

Responses

Request samples

Content type
application/json
{
  • "files": [
    ],
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "client_aliased_name": "string",
  • "client_emails": [
    ],
  • "closed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_client_author": true,
  • "is_client_read": true,
  • "is_closed": true,
  • "is_resolved": true,
  • "number": 0,
  • "splitted_from_ticket_number": 0,
  • "status": {
    },
  • "summary": "string",
  • "type": null,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vote": {
    }
}

Evaluating of ticket

Authorizations:
X-Token
path Parameters
ticket_number
required
integer
Request Body schema: application/json
comment
string non-empty
score
required
integer <int32> [ 1 .. 10 ]

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "score": 1
}

Response samples

Content type
application/json
{
  • "comment": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "score": 0
}

Comments

Comments namespace

Create comment to ticket

Authorizations:
X-Token
path Parameters
ticket_number
required
integer
Request Body schema: application/json
files
Array of strings <uuid> (File) [ 1 .. 10 ] items [ items <uuid > ]
body
required
string [ 1 .. 50000 ] characters

Responses

Request samples

Content type
application/json
{
  • "body": "my second comment"
}

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "body": "string",
  • "id": 0,
  • "is_client_author": true,
  • "is_client_read": true,
  • "sent_at": "2019-08-24T14:15:22Z",
  • "splitted_at": "2019-08-24T14:15:22Z",
  • "splitted_to_ticket_number": 0,
  • "vote": null
}

Returns ticket comments

Authorizations:
X-Token
path Parameters
ticket_number
required
integer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Find comment by ID

Authorizations:
X-Token
path Parameters
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "body": "string",
  • "id": 0,
  • "is_client_author": true,
  • "is_client_read": true,
  • "sent_at": "2019-08-24T14:15:22Z",
  • "splitted_at": "2019-08-24T14:15:22Z",
  • "splitted_to_ticket_number": 0,
  • "vote": null
}

Evaluating of comment

Authorizations:
X-Token
path Parameters
comment_id
required
integer
Request Body schema: application/json
comment
string non-empty
score
required
integer <int32>
Enum: 1 -1

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "score": 1
}

Response samples

Content type
application/json
{
  • "comment": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "score": 0
}

Topics

Topics namespace

Returns all topics

Authorizations:
X-Token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}