Skip to main content

GetSales API Quick Start Guide

Get started with the GetSales API: authenticate, create contacts, send LinkedIn messages, and explore advanced endpoints.

Peter avatar
Written by Peter
Updated over a week ago

Welcome to the GetSales.io Public API! This quick start guide shows how to authenticate, create your first contact, and send LinkedIn messages.

For the full API reference, visit: https://api.getsales.io


πŸ” Authentication

To interact with the API, use a valid API key in every request.

How to Get Your API Key:

  1. Log in to your GetSales.io account

  2. Go to Workspace Settings > API Keys

  3. Copy your existing key or create a new one

Example Header:

Authorization: Bearer {YOUR_TOKEN}

Important: Keep your token secure. Never share it publicly.


πŸ‘€ Creating a Contact

Use this endpoint to add a new lead:
​POST https://amazing.getsales.io/leads/api/leads

Prerequisites:

  • Each contact must belong to a list

  • Copy the List ID from the Lists page (click 3-dot menu β†’ Copy List ID)

Request Example:

POST /leads/api/leads HTTP/1.1
Host: amazing.getsales.io
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json

{
"list_uuid": "uuid-uuid-uuid-uuid-example",
"leads": [
{
"linkedin_id": "john-doe-123456 or ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
"first_name": "John",
"last_name": "Doe",
"company_name": "ExampleCorp",
"ln_id": "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
"sn_id": "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI",
"linkedin": "christina-sletner-b4481a2",
"email": "[email protected]",
"about": "Some facts about John...",
"domain": "somecoolcompany.com",
"headline": "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge",
"position": "Sales & Partner Manager",
"raw_address": "Oslo, Oslo, Norway",
"custom_fields": {
"Gender": "Male",
"Connection_Message": "Hi John, I loved your recent insights on automating LinkedIn voices. I’d appreciate connecting to learn more about your approach and share ideas!",
"First_Message": "Thanks for connection John, I was curious ..."
}
}
]
}

Response:

Returns enriched contact data, including full name, LinkedIn profile, emails, phone numbers, and more.

Note: You can add multiple leads in one request.


πŸ’¬ Managing LinkedIn Messages

πŸ“₯ Retrieve Messages

Use this endpoint to get messages for a specific contact:
​GET https://amazing.getsales.io/flows/api/linkedin-messages

Optional Parameters:

  • limit: Maximum number of messages to retrieve.

  • offset: Offset for pagination.

  • order-field: Field to sort by, default sent_at.

  • order-type: Sorting direction (asc or desc), default desc.

  • filter: JSON object to refine results based on specific fields (e.g., sender_profile_uuid, lead_uuid, status).

Example:

GET /flows/api/linkedin-messages?filter[lead_uuid]=uuid-uuid-uuid-uuid-example HTTP/1.1
Host: api.getsales.io
Authorization: Bearer {YOUR_TOKEN}

πŸ“€ Send a Message

Send a LinkedIn message using this endpoint:
​POST https://amazing.getsales.io/flows/api/messages

Request Example:

POST /flows/api/messages HTTP/1.1
Host: api.getsales.io
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json

{
"sender_profile_uuid": "uuid-uuid-uuid-uuid-example",
"lead_uuid": "uuid-uuid-uuid-uuid-example",
"text": "Hello John, how are you?",
}

Tip: You can use this for both automated and manual LinkedIn outreach.


🧭 What’s Next?

  • Try endpoints for automations, sender profiles, and pipeline status

  • Use the API to automate workflows or integrate with external tools

Need help with your setup or a specific API call? Contact support β€” we’re happy to help!

Did this answer your question?