S
S
Socialboards
Search…
List Tickets
All API requests should contain authorization headers.

Request

1
POST /tickets/list
Copied!

Query Parameters.

This endpoint doesn't require query parameters.

Request Body

1
{
2
"categoryId": 33527,
3
"customFields": [{
4
"key": 18464,
5
"value": "Option 2"
6
}
7
],
8
"from": "2020-01-01T00:00:00+00:00",
9
"orderBy": "last_thread_activity_desc",
10
"skip": 0,
11
"source": "web",
12
"status": "open",
13
"take": 100,
14
"to": "2020-03-02T00:00:00+00:00",
15
"ticketIds": [
16
4484636,
17
4484618,
18
4478963
19
]
20
}
Copied!
Body of request should contain the following model serialized to JSON.
Field
Type
Required
Comments
categoryId
nullabe integer
no
Unique Id of category ticket should belong to. If value is null uncategorized tickets will be selected.
customFields
no
List of models containing custom field ids and values. If array contains several custom fields, tickets must have all of them to be selected in result.
from
string
no
Min creation time of tickets shown in results. string containing DateTime with offset, in the following format: "2020-02-27T12:28:02.6019432+01:00"
orderBy
string
no
Order of tickets in the list. Can be one of TicketListOrderBy enumeration values.
skip
integer
no
Amount of tickets should be skipped from the result.
source
string
no
Source of tickets. Can be one of TicketSource enumeration values.
status
string
no
Ticket status. Can be one of TicketStatus enumeration values.
take
int
no
Max ammount of tickets shown in results. Max value is 50. default: 25
ticketIds
array of integer
no
ids of tickets to select from results. It can be used to fetch tickets by id(s)
to
string
no
Max creation time of tickets shown in results. string containing DateTime with offset, in the following format: "2020-02-27T12:28:02.6019432+01:00"

Response

1
{
2
"data": [
3
{
4
"id": 4484636,
5
"title": "New car price list.",
6
"message": "Hello I want to buy a new car, how can I get a price list?",
7
"htmlMessage": "Hello I want to buy a new car, how can I get a price list?",
8
"author": {
9
"id": "7c0a344a-c369-4e27-9840-88257a56e835",
10
"name": "Bill Smith",
11
"image": null,
12
"email": "[email protected]",
13
"status": "client",
14
"isBot": false
15
},
16
"category": {
17
"id": 15597,
18
"name": "Customers"
19
},
20
"creationTime": "2019-12-18T18:00:03.6368531+00:00",
21
"lastThreadElementCreationTime": "2019-12-18T18:00:03.6368531+00:00",
22
"lockedBy": null,
23
"originalLink": null,
24
"properties": {
25
"isAnonymized": false,
26
"isMuted": false,
27
"hasAttachments": true,
28
"hasDraft": false,
29
"isAssignedToBot": false,
30
"isDeleted": false,
31
"isExpired": true,
32
"isHidden": false,
33
"isLocked": false,
34
"isSpam": false,
35
"isSensitive": false
36
},
37
"replyCount": 0,
38
"sentiment": "question",
39
"source": "web",
40
"detailedSource": "web_website",
41
"sourceName": null,
42
"status": "open",
43
"tags": [
44
"urgent"
45
]
46
},
47
{
48
"id": 4484618,
49
"title": "New car price list.",
50
"message": "Hello I want to buy a new car, how can I get a price list?",
51
"htmlMessage": "Hello I want to buy a new car, how can I get a price list?",
52
"author": {
53
"id": "7c0a344a-c369-4e27-9840-88257a56e835",
54
"name": "Bill Smith",
55
"image": null,
56
"email": "[email protected]",
57
"status": "client",
58
"isBot": false
59
},
60
"category": {
61
"id": 15597,
62
"name": "Customers"
63
},
64
"creationTime": "2019-12-18T17:55:52.6381081+00:00",
65
"lastThreadElementCreationTime": "2019-12-18T17:55:52.6381081+00:00",
66
"lockedBy": null,
67
"originalLink": null,
68
"properties": {
69
"isAnonymized": false,
70
"isMuted": false,
71
"hasAttachments": true,
72
"hasDraft": false,
73
"isAssignedToBot": false,
74
"isDeleted": false,
75
"isExpired": true,
76
"isHidden": false,
77
"isLocked": false,
78
"isSpam": false,
79
"isSensitive": false
80
},
81
"replyCount": 0,
82
"sentiment": "question",
83
"source": "web",
84
"detailedSource": "web_website",
85
"sourceName": null,
86
"status": "open",
87
"tags": []
88
},
89
{
90
"id": 4478963,
91
"title": "Cat is ill",
92
"message": "I want to take my cat to a vet",
93
"htmlMessage": "I want to take my cat to a vet",
94
"author": {
95
"id": "35692164-bfaa-4c49-a23c-ecfa618f7d20",
96
"name": "Robert Baker",
97
"image": null,
98
"email": "[email protected]",
99
"status": "client",
100
"isBot": false
101
},
102
"category": {
103
"id": 15721,
104
"name": "Other cases"
105
},
106
"creationTime": "2019-12-17T07:03:48.318717+00:00",
107
"lastThreadElementCreationTime": "2019-12-17T07:21:21.5003556+00:00",
108
"lockedBy": null,
109
"originalLink": null,
110
"properties": {
111
"isAnonymized": false,
112
"isMuted": false,
113
"hasAttachments": false,
114
"hasDraft": false,
115
"isAssignedToBot": false,
116
"isDeleted": false,
117
"isExpired": true,
118
"isHidden": false,
119
"isLocked": false,
120
"isSpam": false,
121
"isSensitive": false
122
},
123
"replyCount": 3,
124
"sentiment": "question",
125
"source": "web",
126
"detailedSource": "web_website",
127
"sourceName": null,
128
"status": "open",
129
"tags": []
130
}
131
],
132
"errorCode": -1,
133
"errorText": null
134
}
Copied!
Data field will contain array of ticket models.
Last modified 1yr ago
Copy link