List people who can follow a ticket
Answers the people you may add as followers, as the picker on the ticket page offers them: up to six active people whose name contains search, from the companies that may follow the ticket. For an agency these are the ticket's client company and the agency itself; for a client, its own company.
GET/ api/ support/ tickets/ {ticket}/ subscriber-candidates
Path parameters
ticketintegerRequired
The number of a ticket. Digits only. At least 1.
Query parameters
searchstring
Part of a name. The first six people when left out. Up to 255 characters.
Returns
200 The people you may add.
Fields of the 200 answer
candidatesarray of objectsRequired
Up to 6 items.
Fields of each item
company_namestring or nullRequired
emailstring or nullRequired
idintegerRequired
At least 1.
namestringRequired
searchstringRequired
ticket_idintegerRequired
At least 1.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/support/tickets/48210/subscriber-candidates \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/support/tickets/48210/subscriber-candidates');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/support/tickets/48210/subscriber-candidates', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/support/tickets/48210/subscriber-candidates",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"candidates": [
{
"company_name": "Harbour & Finch",
"email": "[email protected]",
"id": 2042,
"name": "Tom Harbour"
}
],
"search": "Tom",
"ticket_id": 48210
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You cannot change who follows this ticket.",
"reason": "forbidden"
}{
"message": "Not found."
}{
"code": "invalid",
"errors": {
"search": [
"The search may not be greater than 255 characters."
]
},
"field": "search",
"message": "The search may not be greater than 255 characters.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?