# GetSales.io Public API You will find here GetSales.io Public API documentation Version: 3.0 License: Copyright ## Servers Production environment ``` https://amazing.getsales.io ``` ## Security ### bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [GetSales.io Public API](https://api.getsales.io/_spec/api/openapi.yaml) ## Contacts Contacts API ### Find one contact - [POST /leads/api/leads/lookup-one](https://api.getsales.io/api/openapi/contacts/findonecontact.md): Retrieve a single contact based on provided identification fields. You must supply at least one identifier—either a linkedin_id, an email, or both name and company_name together. linkedin_id could be an url or a nickname string. ### Search contacts - [POST /leads/api/leads/search](https://api.getsales.io/api/openapi/contacts/searchcontacts.md): Searches contacts using advanced filters, sorting, and pagination. Returns a list of matched contacts with optional aggregation. ### Supported Filter Value Types: - → query - → Comparison query with operators Supported operators: , , `>="is_null"IS NULL"is_not_null"IS NOT NULL"linkedin_status": "ok"` ### Get contact by UUID - [GET /leads/api/leads/{uuid}](https://api.getsales.io/api/openapi/contacts/getlead.md): Get Contact by UUID ### Update contact by UUID - [PUT /leads/api/leads/{uuid}](https://api.getsales.io/api/openapi/contacts/updatelead.md): Update Contact by UUID ### Delete a Contact - [DELETE /leads/api/leads/{uuid}](https://api.getsales.io/api/openapi/contacts/deletelead.md): Delete a contact identified by its UUID. This operation dispatches a contact delete job that creates a mass action item and a delete payload indicating that the contact was manually deleted by the user. ### Create or Update a contact - [POST /leads/api/leads/upsert](https://api.getsales.io/api/openapi/contacts/upsertcontact.md): Creates or updates a contact in the specified list. If the contact exists and is true, it will be updated. Optionally, the contact can also be moved to the specified list. ## Automations Automations API ### List of automations - [GET /flows/api/flows](https://api.getsales.io/api/openapi/automations/listflows.md): List of Automations ### Start a automation - [PUT /flows/api/flows/{flowUuid}/start](https://api.getsales.io/api/openapi/automations/startflow.md): Start a Automation ### Stop an automation - [PUT /flows/api/flows/{flowUuid}/stop](https://api.getsales.io/api/openapi/automations/stopflow.md): Stop an Automation ### Add contact to automation - [POST /flows/api/flows/{flowUuid}/leads/{leadUuid}](https://api.getsales.io/api/openapi/automations/addleadtoflow.md): Add Contact to Automation ### Add a new contact to automation - [POST /flows/api/flows/{flowUuid}/add-new-lead](https://api.getsales.io/api/openapi/automations/addnewleadtoflow.md): This endpoint adds a new lead to a particular automation. A lead is created with the given list UUID and attached to the automation. If is provided only new contacts will be added to automation, otherwise the request returns a reason "skipped." ### Cancel Contact from Specific Automations - [PUT /flows/api/flows/leads/{leadUuid}/cancel](https://api.getsales.io/api/openapi/automations/cancelleadfromflows.md): Cancel a contact from specific automation flows. The request must include an array of flow UUIDs ("flow_uuids") indicating the automation flows from which the contact (identified by leadUuid) should be cancelled. For each specified flow, a cancellation job is dispatched immediately with the reason "Automation cancelled manually". ### Cancel Contact from All Automations - [PUT /flows/api/flows/leads/{leadUuid}/cancel-all](https://api.getsales.io/api/openapi/automations/cancelleadfromallflows.md): Cancel a contact from all active automation flows. The operation retrieves all active flows associated with the lead (identified by leadUuid) and dispatches cancellation jobs for each one with the reason "Automation cancelled manually". ## Unibox Unified inbox API ### List of LinkedIn Messages - [GET /flows/api/linkedin-messages](https://api.getsales.io/api/openapi/unibox/listlinkedinmessages.md): List of LinkedIn messages ### Send LinkedIn Message - [POST /flows/api/linkedin-messages](https://api.getsales.io/api/openapi/unibox/sendlinkedinmessage.md): Send LinkedIn Message ### List of Emails - [GET /emails/api/emails](https://api.getsales.io/api/openapi/unibox/listemails.md): List of emails ### Send Email - [POST /emails/api/emails/send-email](https://api.getsales.io/api/openapi/unibox/sendemail.md): Send a new email ## Sender Profiles Sender profiles API ### List of Sender Profiles - [GET /flows/api/sender-profiles](https://api.getsales.io/api/openapi/sender-profiles/listsenderprofiles.md): List of Sender Profiles ### Create Sender Profile - [POST /flows/api/sender-profiles](https://api.getsales.io/api/openapi/sender-profiles/createsenderprofile.md): Create Sender Profile ### Get Sender Profile by Uuid - [GET /flows/api/sender-profiles/{senderProfileUuid}](https://api.getsales.io/api/openapi/sender-profiles/getsenderprofile.md): Get Sender Profile by Uuid ### Connect Sender Profile (with external GoLogin) - [POST /flows/client-api/sender-profiles/connect-external](https://api.getsales.io/api/openapi/sender-profiles/connectsenderprofile.md): Creates a new with the provided first/last name, schedule and Gologin ID. Automatically connects the profile to a using the provided . Requires authentication and active subscription. Will fail if the sender profile limit is reached. ## Lists ### List of Lists - [GET /leads/api/lists](https://api.getsales.io/api/openapi/lists/listlists.md): List of Lists ### Create New List - [POST /leads/api/lists](https://api.getsales.io/api/openapi/lists/createlist.md): Create New List ### Get List by UUID - [GET /leads/api/lists/{uuid}](https://api.getsales.io/api/openapi/lists/getlist.md): Get List by UUID