API v3

Where can I find the API v3 documentation? You can find whole LiveAgent API documentation within your LiveAgent account: https://YOURDOMAIN.ladesk.com/docs/api/v3/#/ You can also navigate into your agent panel > Configuration > System > API > API V3 DOCUMENTATION How can I try LiveAgent API v3 with my account? Within the documentation, you can find examples and use the possibility to test the API commands with your account. - Consider registering a new free Trial a...

With API v3 you have an option to use filters to get specific results. Filters for the GET /tickets API to retrieve a list of tickets are especially limited, for more details and all available options please [see this article](https://support.liveagent.com/870644-Filtering-API-v3-GET-tickets-results). Simple filters Using a simple filterm you can filter results by searching for a specific column with an exact value: {"parameter":"value"} This simple filter allows you to retrieve e.g. ticket...

To filter the retrieved list of tickets it is possible to use only the filters which are available in the agent panel. Some filters, e.g. {"subject":"order"} work slightly differently than expected. Instead of searching for "subject equals order" it searches for "subject contains order", so it would find all tickets containing the word "order" in subject, e.g. tickets with the subject "Order #123", "Order #456", or even "Order-inquiry". It is also possible to use the search parameter to do a f...

When using LiveAgent, the dates and times displayed in the panel are automatically recalculated according to the user's PC time zone. However, API v3 returns data according to the time zone of your LiveAgent account. This can lead to discrepancies when, for example, searching for tickets in the panel and retrieving ticket lists via API. To align the dates and times with your preferred timezone, you need to add a Timezone-Offset header to your API calls. This will adjust the time of the retrieved...

Some API requests that contain the _perPage parameter don't have the _page parameter to display the next page. Instead of the _page parameter you'd need to use the _cursor parameter to display the next page with records. List of requests utilizing the _cursor parameter - GET /calls - GET /grid/reports/time - GET /phone_numbers - GET /tickets/history The value for the _cursor parameter is provided to you in the response header as the next_page_cursor header value. So essentiall...

If you need to generate LiveAgent's API library / SDK for your preferred programming language (like for example C#) you can use the swagger (OpenAPI) API descriptor which can be found at the very top of the API v3 documentation (https://support.liveagent.com/567924-Documentation--examples).