🐙 Intro
Welcome to the documentation for the tickets feature of our API. This feature allows you to access and filtering tickets. To ensure security and proper authorization, all endpoints require authentication through an API key. You can obtain the API key by contacting our support team.
🔒 Authentication
To access any of the contacts feature endpoint, you must provide a valid API key in all your requets.
To know more about out authentication methods you can access the Authentication document.
🌐 Endpoints
- GET /tickets: Retrieve all or apply filters and pagination to retrive specific tickets;
- GET /tickets/{number}: Retrieve a specific tickets based on the number;
- GET /tickets/status: Get all status available for tickets;
- GET /tickets/channels: Get all channels available for tickets;
- GET /tickets/types: Get all types available for tickets;
- GET /tickets/priorities: Get all tickets priorities;
- GET /tickets/tags: Get all tickets tags;
- GET /tickets/groups: Get all tickets groups;
- GET /tickets/forms: Get all forms available for tickets;
- GET /tickets/forms/{id}: Get field information about a specific form;
- POST /tickets: Create a new ticket
📔 Filters, Pagination and Sorting
To filter contacts you can use the GET /tickets endpoint with the filters based on specific search criteria and use the pagination and sort to organize your result as you wish.
📗 Available Filters
| Property | Format | Description |
|---|---|---|
| number | number | Ticket number |
| summary | string | Ticket summary |
| channel.name | string | Ticket channel name |
| channel.id | string | Ticket channel ID |
| status.name | string | Status name |
| status.id | string | Status ID |
| type.name | string | Ticket type name |
| type.id | string | Ticket type ID |
| requester.name | string | Ticket initiator's name |
| requester.email | string | Ticket initiator's email |
| group.name | string | The group's name to which the ticket belongs |
| organization.name | string | |
| createdAt | Date | Ticket open date. Ex: '2023-10-05T00:00:00-03:00' |
| updatedAt | Date | Ticket updated date. Ex: '2023-10-05T00:00:00-03:00' |
| interactionsCount | number | Ticket interactions quantity |
To know more about how to use these filtering and organization tools look at these documents:
You can use the sorting (sort), pagination (page and limit), and filtering (filters) features together to tailor your API queries and retrieve precisely the data you need.