Lists tickets - Gorelo Documentation

GET

tickets

Lists tickets

curl --request GET \
  --url https://api.usw.gorelo.io/v1/tickets \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/tickets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/tickets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/tickets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/tickets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Title": "<string>",
      "Number": 123,
      "DisplayNumber": "<string>",
      "ClientId": 123,
      "LocationId": 123,
      "ContactId": 123,
      "CcContactIds": [
        123
      ],
      "LeadAssigneeId": 123,
      "AssistingAssigneeIds": [
        123
      ],
      "WatcherIds": [
        123
      ],
      "GroupIds": [
        123
      ],
      "PrimaryGroupId": 123,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "StatusUpdatedOn": "2023-11-07T05:31:56Z",
      "StatusReason": "<string>",
      "Priority": {
        "Id": 1,
        "Name": "<string>"
      },
      "Source": {
        "Id": 1,
        "Name": "<string>"
      },
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "TagIds": [
        123
      ],
      "ChecklistSummary": {
        "Completed": 123,
        "Total": 123
      },
      "IsUnread": true,
      "IsWaitingOnThem": true,
      "IsMerged": true,
      "MergedIntoTicketId": 123,
      "MergedTicketIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "Sla": {
        "FirstResponse": {
          "ElapsedBusinessMinutes": 123
        }
      },
      "LastUpdate": {
        "UpdateType": "<string>",
        "Summary": "<string>",
        "On": "2023-11-07T05:31:56Z"
      },
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "ClosedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autorizações

X-API-Key

string

header

obrigatório

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Parâmetros de consulta

Cursor

string

Opaque pagination cursor from a previous page; omit for the first page.

PageSize

integer<int32>

padrão:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

SortBy

string

padrão:updatedOn

Sort field: updatedOn (default) or createdOn.

SortOrder

string

padrão:desc

Sort direction: asc or desc (default).

StatusIds

string

Comma-separated status ids to include. Omit for every status.

ClientIds

string

Comma-separated client ids to include. Omit for every client.

PriorityIds

string

Comma-separated priority ids on the public scale — None=0, Urgent=1, High=2, Normal=3, Low=4.

TypeIds

string

Comma-separated ticket type ids to include.

LeadAssigneeIds

string

Comma-separated lead assignee ids to include.

ContactIds

string

Comma-separated contact ids to include.

TagIds

string

Comma-separated tag ids; a ticket matches if it carries any of them.

GroupIds

string

Comma-separated group ids; a ticket matches if it is subscribed to any of them.

DeviceIds

string

Comma-separated agent ids (GUIDs, up to 100); a ticket matches if any of those agents is linked to it.

Query

string

Keyword matched against the ticket title, number and display number. Up to 200 characters.

UpdatedSince

string<date-time>

ISO-8601 timestamp; keeps only tickets updated at or after it.

UpdatedBefore

string<date-time>

ISO-8601 timestamp; keeps only tickets updated strictly before it.

CreatedSince

string<date-time>

ISO-8601 timestamp; keeps only tickets created at or after it.

CreatedBefore

string<date-time>

ISO-8601 timestamp; keeps only tickets created strictly before it.

Resposta

StatusCode

enum<integer>

Opções disponíveis:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object[] | null

Show child attributes

DataContext

object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Show child attributes

Notifications

object[]

Show child attributes

⌘I

Lists tickets

curl --request GET \
  --url https://api.usw.gorelo.io/v1/tickets \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/tickets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/tickets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/tickets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/tickets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "Title": "<string>",
      "Number": 123,
      "DisplayNumber": "<string>",
      "ClientId": 123,
      "LocationId": 123,
      "ContactId": 123,
      "CcContactIds": [
        123
      ],
      "LeadAssigneeId": 123,
      "AssistingAssigneeIds": [
        123
      ],
      "WatcherIds": [
        123
      ],
      "GroupIds": [
        123
      ],
      "PrimaryGroupId": 123,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "StatusUpdatedOn": "2023-11-07T05:31:56Z",
      "StatusReason": "<string>",
      "Priority": {
        "Id": 1,
        "Name": "<string>"
      },
      "Source": {
        "Id": 1,
        "Name": "<string>"
      },
      "Type": {
        "Id": 1,
        "Name": "<string>"
      },
      "TagIds": [
        123
      ],
      "ChecklistSummary": {
        "Completed": 123,
        "Total": 123
      },
      "IsUnread": true,
      "IsWaitingOnThem": true,
      "IsMerged": true,
      "MergedIntoTicketId": 123,
      "MergedTicketIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "Sla": {
        "FirstResponse": {
          "ElapsedBusinessMinutes": 123
        }
      },
      "LastUpdate": {
        "UpdateType": "<string>",
        "Summary": "<string>",
        "On": "2023-11-07T05:31:56Z"
      },
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "ClosedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}