---
name: unipile-api
description: "Reference for the Unipile API. Use whenever the user asks about the Unipile API HTTP API, REST endpoints, webhooks, authentication/API tokens, or needs developer/product documentation for Unipile API. Cite source URLs when giving API details."
---

# Unipile API Skill

You are a helpful assistant with deep knowledge of **Unipile API**.

## Topic folders

Reference material is organized into topic folders. Pick a topic, read its folder `_index.md`, then open the specific file you need.

| Folder | Index | Description | Pages |
| --- | --- | --- | --- |
| Accounts | [accounts/_index.md](accounts/_index.md) | Update the proxy configuration of an existing account. You can provide a custom proxy, or request a new Unipile proxy by country/IP. Allows you to provide a code which will solve a checkpoint encountered during a native authentication. A checkpoint is a security step added by a provider which needs... | 11 |
| Calendars | [calendars/_index.md](calendars/_index.md) | Retrieve the details of a calendar event. Returns a list of calendar events related to the given calendar. Retrieve the details of a calendar. | 8 |
| Chatattendees | [chatattendees/_index.md](chatattendees/_index.md) | The id of the wanted attendee. Returns a list of messages where a given attendee is involved. Returns a list of messaging attendees. Some optional parameters are available to filter the results. | 5 |
| Chats | [chats/_index.md](chats/_index.md) | This route can be used both to initiate a synchronization process and to monitor its status via regular polling. Start a new conversation with one or more attendee. ⚠️ Interactive documentation does not work for Linkedin specific parameters (child parameters not correctly applied in snippet), the... | 9 |
| Drafts | [drafts/_index.md](drafts/_index.md) | ⚠️ Interactive documentation does not work on this route (child parameters not correctly applied in snippet), Create a new draft. | 1 |
| Emails | [emails/_index.md](emails/_index.md) | Returns a list of emails. | 1 |
| Folders | [folders/_index.md](folders/_index.md) | Retrieve the details of a mail folder. Returns a list of all email folders. | 2 |
| Hosted | [hosted/_index.md](hosted/_index.md) | Create a url which redirect to Unipile's hosted authentication to connect or reconnect an account. | 1 |
| Linkedin | [linkedin/_index.md](linkedin/_index.md) | Solve a checkpoint to verify your member privilegies. Select a Recruiter or Sales navigator contract to be used on your account Retrieve list of LinkedIn Recruiter hiring projects. | 21 |
| Linkedin Specific | [linkedin-specific/_index.md](linkedin-specific/_index.md) | Retrieve list of LinkedIn Recruiter hiring projects. | 1 |
| Mails | [mails/_index.md](mails/_index.md) | ⚠️ Interactive documentation does not work on this route (child parameters not correctly applied in snippet), please use our ready to copy past example of this page : https://developer.unipile.com/docs/send-email Retrieve the details of an email. Retrieve one of the attachment linked to an email. | 7 |
| Messages | [messages/_index.md](messages/_index.md) | Retrieve one of the attachment linked to a message. Retrieve the details of a message. Returns a list of messages. Some optional parameters are available to filter the results. | 7 |
| Messaging | [messaging/_index.md](messaging/_index.md) | Returns a list of chats. Some optional parameters are available to filter the results. | 1 |
| Posts | [posts/_index.md](posts/_index.md) | Retrieve the details of a post. Returns a list of reactions to either a post or a post comment. Returns a list of either comments on a given post or replies on a given comment. | 7 |
| Users | [users/_index.md](users/_index.md) | Send an invitation to add someone to your contacts. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions Retrieve informations about account owner. Retrieve the profile of a user. Ensure... | 15 |
| Webhooks | [webhooks/_index.md](webhooks/_index.md) | Returns a list of the webhooks. | 4 |

## How to use this skill

1. Find the relevant topic folder in the table above.
2. Read that folder's `_index.md` to see the files it contains.
3. Open the specific file that matches the endpoint or concept you're asking about.
4. Cite the source URL when giving API details.
5. If the user asks about something not covered, say so.