API

Home > Frequently asked questions > General > API

When I am using "GET tickets" API , it returns max. 1000 rows. How can I get all results?

Customer context: The customer is a software developer who is making use of LiveAgent's "GET tickets" API in their project, but they're encountering limitations with the number of rows being returned. Customer: When I am using "GET tickets" API , it returns max. 1000 rows. How can I get all results? Answer: If you would like to load more results, you need to use it in a cycle and use the parameter "_page" to load the next 1000 rows. If the API you are using doesn't have the "_page" parameter, ...

Why are some API endpoints available in API v1 but not in v3 and vice versa?

Customer context: The customer would like to use specific API endpoints from both v1 and v3 versions and is curious about the discrepancy in available endpoints between the versions. Customer: Why are some API endpoints available in API v1 but not in v3 and vice versa? Answer: API v1 is deprecated, meaning no new endpoints will be added to it. On the other hand, API v3 is a newer version still under development, so enhancements and new endpoints are being added continuously. You have the abili...

How can I export my emails data & history to my own database using API?

Customer context: The customer desires to export their email data and content to their personal database using API. They expect the system to automatically backup the data every month. Customer: How can I export my emails data & history to my own database using API? Answer: You can use API v3 to retrieve all tickets created over the past month via API GET /tickets, get the details of each ticket via API GET /tickets/{ticketId}, and get every message of each ticket via API GET /tickets/{ticketI...

What are the limitations of exporting data using API?

Customer context: A customer is using LiveAgent's API and wants to know its limitations when exporting data. Customer: What are the limitations of exporting data using API? Answer: The API rate limit is currently set to 180 requests per minute. This limit applies to each API key separately.

How can I remove the VIP group tag in bulk for clients listed in an Excel document?

Customer context: The customer would like to remove the VIP group tag in bulk for a list of clients they have in an Excel document. Customer: How can I remove the VIP group tag in bulk for clients listed in an Excel document? Answer: You can achieve this using LiveAgent's APIv3. You can use an API call to update contacts and remove the VIP group tag. The API documentation can be found at https://support.liveagent.com/567924-Documentation

Can I get internal notes using LiveAgent's API?

Customer context: A customer wants to access internal notes from a helpdesk software called LiveAgent using their API. Customer: Can I get internal notes using LiveAgent's API? Answer: Sure, you can first retrieve all message groups and then filtrate them based on your needs. To see all options please navigate to Configuration > System > API > API v3 documentation directly in your LiveAgent panel.

Can I import Canned messages and Predefined answers into LiveAgent in bulk?

Customer context: A customer wants to import canned messages and predefined answers in bulk. Customer: Can I import Canned messages and Predefined answers into LiveAgent in bulk? Answer: Currently, there is no option to import Canned messages (https://support.liveagent.com/471194-Canned-messages) and Predefined answers (https://support.liveagent.com/806278-Predefined-answers) from CSV. To create them in bulk, you can either enter them one by one or, if you are familiar with API, navigate to Co...

Can I export Canned messages and Predefined answers from LiveAgent?

Customer context: A LiveAgent user who wants to export canned and predefined answers from the platform. Customer: Can I export Canned messages and Predefined answers from LiveAgent? Answer: There is no direct CSV export feature available for Canned messages (https://support.liveagent.com/471194-Canned-messages) and Predefined answers (https://support.liveagent.com/806278-Predefined-answers) in LiveAgent. However, you can use the LiveAgent API v3 for this purpose. To export Canned messages and ...

Where can I find the APIv1 documentation?

Customer context: A customer looking for the APIv1 documentation for LiveAgent. Customer: Where can I find the APIv1 documentation? Answer: You can find the LiveAgent APIv1 documentation in our Knowledge Base at the following link: https://support.liveagent.com/840770-Complete-API-reference

Where can I find the APIv3 documentation?

Customer context: A customer looking for the APIv3 documentation for LiveAgent. Customer: Where can I find the APIv3 documentation? Answer: You can find the LiveAgent APIv3 documentation in your agent panel by navigating to Configuration > System > API > APIv3 documentation. Please note that this section is only accessible by Admins or the Owner.

Can I create a ticket using API?

Customer context: A customer inquiring about creating a ticket using the API. Customer: Can I create a ticket using API? Answer: Yes, you can create a ticket using the APIv3 documentation, found in your LiveAgent panel under Configuration > System > API > APIv3 documentation. Expand the "Tickets" row and open the "Post" section to view all available parameters. You can even test the process within this environment by clicking the "Try it out" button.

Can I retrieve my ticket list using API?

Customer context: A customer inquiring about retrieving their ticket list using the API. Customer: Can I retrieve my ticket list using API? Answer: Yes, you can retrieve your ticket list using the APIv3 documentation, found in your LiveAgent panel under Configuration > System > API > APIv3 documentation. Expand the "Tickets" row and open the "Get /tickets" section to view all available parameters. You can even test the process within this environment by clicking the "Try it out" butto...

Can I retrieve a specific ticket using API?

Customer context: A customer wants to retrieve a specific ticket using the LiveAgent API. Customer: Can I retrieve a specific ticket using API? Answer: Yes, you can retrieve a specific ticket using the API. First, go to Configuration > System > API > APIv3 documentation in your LiveAgent panel. Expand the "Tickets" row and open the "Get /tickets" section to see all available parameters. Retrieve the ticket list to obtain the ticketID of the desired ticket. Then, use the "Get /tickets/...

Can I update a specific ticket using API?

Customer context: A customer wants to update a specific ticket using the LiveAgent API. Customer: Can I update a specific ticket using API? Answer: Yes, you can update a specific ticket using the API. Go to Configuration > System > API > APIv3 documentation in your LiveAgent panel. Expand the "Tickets" row and open the "Get /tickets" section to see all available parameters. Retrieve the ticket list to find the ticketID of the specific ticket you want to update. Then, use the "Put /tic...

How can I import contacts of respective groups under the same Contact groups to our LiveAgent account?

Customer context: The customer has created more Contact groups in their LiveAgent account and wants to import contacts under the respective groups. Customer: How can I import contacts of respective groups under the same Contact groups to our LiveAgent account? Answer: You can import contacts to your LiveAgent account by using the attached PHP script in the following article: How to import contacts from CSV (https://support.liveagent.com/399768-How-to-import-contacts-from-csv) named import_Cont...

How can I set the filter so I can include both tag IDs in my ticket result?

Customer context: The customer wants to know how to set the filters to include both tag IDs in their LiveAgent tickets result. Customer: How can I set the filter so I can include both tag IDs in my ticket result? Answer: You can use the following filter in your search query to retrieve tickets containing both tags: [["tags","L","tagID1,tagID2"]] For further information, you can refer to How to use advanced filters (https://support.liveagent.com/513528-How-to-use-advanced-filters) or API doc...