GetSales.io Public API (3.0)

You will find here GetSales.io Public API documentation

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://getsales.io
GetSales.io Support Team support@getsales.io
License Copyright
Languages
Servers
Production environment
https://amazing.getsales.io/

Contacts

Contacts API

Operations

Find one contact

Request

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.

Bodyapplication/jsonrequired

Data for looking up a contact. If linkedin_id is provided, it will be processed to derive related identification information. Alternatively, you can provide an email or a combination of name and company_name.

Any of:
linkedin_idstring or nullrequired

LinkedIn ID used for lookup. If provided, it will be parsed to extract additional contact identifiers.

emailstring or null

Email address used for contact identification.

namestring or null

Contact's name.

company_namestring or null

Company name.

disable_aggregationboolean

When true, disables contact data aggregation.

curl -i -X POST \
  https://amazing.getsales.io/leads/api/leads/find-one \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "linkedin_id": "string",
    "email": "string",
    "name": "string",
    "company_name": "string",
    "disable_aggregation": true
  }'

Responses

Successful response with the contact data.

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
user_idinteger or null
Example: 1
sender_profile_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
list_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
data_source_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
pipeline_stage_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
company_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
namestring or null
Example: "Christina Sletner"
first_namestring or null
Example: "Christina"
last_namestring or null
Example: "Sletner"
company_namestring or null
Example: "Advania Norge"
company_ln_idstring or null
Example: "98"
positionstring or null
Example: "Sales & Partner Manager"
headlinestring or null
Example: "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge"
aboutstring or null
Example: "Busy times with contributing to our customers' cloud journey..."
avatar_urlstring or null
Example: "https://example.com/avatar.jpg"
ln_idstring or null
Example: "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
sn_idstring or null
Example: "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"
linkedinstring or null
Example: "christina-sletner-b4481a2"
facebookstring or null
Example: "christina-sletner"
twitterstring or null
Example: "christina-sletner"
work_emailstring or null
Example: "christina.sletner@advania.no"
personal_emailstring or null
Example: "christina88@yahoo.com"
work_phone_numberstring or null
Example: "+123456789"
personal_phone_numberstring or null
Example: "+123456789"
connections_numberinteger or null
Example: 500
followers_numberinteger or null
Example: 1000
primary_languagestring or null
Example: "en"
supported_languagesArray of strings or null
Example: ["en","no"]
has_open_profileinteger or null
Example: 1
has_verified_profileinteger or null
Example: 1
has_premiuminteger or null
Example: 1
experienceArray of objects or null
postsArray of objects or null
educationsArray of objects or null
skillsArray of strings or null
Example: ["Project Management","Sales","ERP Systems"]
top_voicesArray of strings or null
Example: ["Thought Leader 1","Influencer 2"]
raw_addressstring or null
Example: "Oslo, Oslo, Norway"
locationArray of objects or null
tagsArray of strings or null
Example: ["uuid-uuid-uuid-uuid-example","uuid-uuid-uuid-uuid-example"]
statusstring
Example: "ok"
linkedin_statusstring
Example: "active"
email_statusstring or null
Example: "verified"
unread_countsArray of objects
last_automation_approve_atstring or null(date-time)
Example: "2023-07-21T10:15:30Z"
created_atstring or null(date-time)
Example: "2022-12-11T10:00:00Z"
updated_atstring or null(date-time)
Example: "2022-12-11T11:00:00Z"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "user_id": 1,
  "sender_profile_uuid": "uuid-uuid-uuid-uuid-example",
  "list_uuid": "uuid-uuid-uuid-uuid-example",
  "data_source_uuid": "uuid-uuid-uuid-uuid-example",
  "pipeline_stage_uuid": "uuid-uuid-uuid-uuid-example",
  "company_uuid": "uuid-uuid-uuid-uuid-example",
  "name": "Christina Sletner",
  "first_name": "Christina",
  "last_name": "Sletner",
  "company_name": "Advania Norge",
  "company_ln_id": "98",
  "position": "Sales & Partner Manager",
  "headline": "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge",
  "about": "Busy times with contributing to our customers' cloud journey...",
  "avatar_url": "https://example.com/avatar.jpg",
  "ln_id": "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
  "sn_id": "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI",
  "linkedin": "christina-sletner-b4481a2",
  "facebook": "christina-sletner",
  "twitter": "christina-sletner",
  "work_email": "christina.sletner@advania.no",
  "personal_email": "christina88@yahoo.com",
  "work_phone_number": "+123456789",
  "personal_phone_number": "+123456789",
  "connections_number": 500,
  "followers_number": 1000,
  "primary_language": "en",
  "supported_languages": [
    "en",
    "no"
  ],
  "has_open_profile": 1,
  "has_verified_profile": 1,
  "has_premium": 1,
  "experience": [
    { … }
  ],
  "posts": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "skills": [
    "Project Management",
    "Sales",
    "ERP Systems"
  ],
  "top_voices": [
    "Thought Leader 1",
    "Influencer 2"
  ],
  "raw_address": "Oslo, Oslo, Norway",
  "location": [
    { … }
  ],
  "tags": [
    "uuid-uuid-uuid-uuid-example",
    "uuid-uuid-uuid-uuid-example"
  ],
  "status": "ok",
  "linkedin_status": "active",
  "email_status": "verified",
  "unread_counts": [
    { … }
  ],
  "last_automation_approve_at": "2023-07-21T10:15:30Z",
  "created_at": "2022-12-11T10:00:00Z",
  "updated_at": "2022-12-11T11:00:00Z"
}

Search contacts

Request

Searches contacts using advanced filters, sorting, and pagination. Returns a list of matched contacts with optional aggregation.

Supported Filter Value Types:

  • Array → IN query "work_email": ["john@example.com", "simon@example.com"]

  • Object → Comparison query with operators "created_at": {">=": "2023-01-01"}

    Supported operators: =, !=, <, <=, >, >=, <>

  • Special Strings

    • "is_null" → IS NULL
    • "is_not_null" → IS NOT NULL

  • Scalar value → Equals query "linkedin_status": "ok"

Bodyapplication/jsonrequired
filterobject

Filters to apply when searching contacts.

Example: {"name":"John Smith","company_name":"Example Inc.","email_status":"ok"}
limitinteger>= 1

Number of contacts to return.

Default 20
Example: 20
offsetinteger>= 0

Number of contacts to skip.

Default 0
Example: 0
order_fieldstring

Field to sort by.

Default "created_at"
Example: "name"
order_typestring

Sorting direction.

Default "desc"
Enum"asc""desc"
Example: "asc"
disable_aggregationboolean

If true, disables contact data aggregation in the response.

Default false
Example: false
curl -i -X POST \
  https://amazing.getsales.io/leads/api/leads/search \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "name": "John Smith",
      "company_name": "Example Inc.",
      "email_status": "ok"
    },
    "limit": 20,
    "offset": 0,
    "order_field": "name",
    "order_type": "asc",
    "disable_aggregation": false
  }'

Responses

List of matching contacts

Bodyapplication/json
dataArray of objects(lead)

List of found contacts

limitinteger
Example: 20
offsetinteger
Example: 0
totalinteger

Total number of contacts matching the filter

Example: 142
Response
application/json
{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "total": 142
}

Get contact by UUID

Request

Get Contact by UUID

Path
uuidstringrequired

UUID of Contact

curl -i -X GET \
  'https://amazing.getsales.io/leads/api/leads/{uuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
user_idinteger or null
Example: 1
sender_profile_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
list_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
data_source_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
pipeline_stage_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
company_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
namestring or null
Example: "Christina Sletner"
first_namestring or null
Example: "Christina"
last_namestring or null
Example: "Sletner"
company_namestring or null
Example: "Advania Norge"
company_ln_idstring or null
Example: "98"
positionstring or null
Example: "Sales & Partner Manager"
headlinestring or null
Example: "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge"
aboutstring or null
Example: "Busy times with contributing to our customers' cloud journey..."
avatar_urlstring or null
Example: "https://example.com/avatar.jpg"
ln_idstring or null
Example: "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
sn_idstring or null
Example: "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"
linkedinstring or null
Example: "christina-sletner-b4481a2"
facebookstring or null
Example: "christina-sletner"
twitterstring or null
Example: "christina-sletner"
work_emailstring or null
Example: "christina.sletner@advania.no"
personal_emailstring or null
Example: "christina88@yahoo.com"
work_phone_numberstring or null
Example: "+123456789"
personal_phone_numberstring or null
Example: "+123456789"
connections_numberinteger or null
Example: 500
followers_numberinteger or null
Example: 1000
primary_languagestring or null
Example: "en"
supported_languagesArray of strings or null
Example: ["en","no"]
has_open_profileinteger or null
Example: 1
has_verified_profileinteger or null
Example: 1
has_premiuminteger or null
Example: 1
experienceArray of objects or null
postsArray of objects or null
educationsArray of objects or null
skillsArray of strings or null
Example: ["Project Management","Sales","ERP Systems"]
top_voicesArray of strings or null
Example: ["Thought Leader 1","Influencer 2"]
raw_addressstring or null
Example: "Oslo, Oslo, Norway"
locationArray of objects or null
tagsArray of strings or null
Example: ["uuid-uuid-uuid-uuid-example","uuid-uuid-uuid-uuid-example"]
statusstring
Example: "ok"
linkedin_statusstring
Example: "active"
email_statusstring or null
Example: "verified"
unread_countsArray of objects
last_automation_approve_atstring or null(date-time)
Example: "2023-07-21T10:15:30Z"
created_atstring or null(date-time)
Example: "2022-12-11T10:00:00Z"
updated_atstring or null(date-time)
Example: "2022-12-11T11:00:00Z"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "user_id": 1,
  "sender_profile_uuid": "uuid-uuid-uuid-uuid-example",
  "list_uuid": "uuid-uuid-uuid-uuid-example",
  "data_source_uuid": "uuid-uuid-uuid-uuid-example",
  "pipeline_stage_uuid": "uuid-uuid-uuid-uuid-example",
  "company_uuid": "uuid-uuid-uuid-uuid-example",
  "name": "Christina Sletner",
  "first_name": "Christina",
  "last_name": "Sletner",
  "company_name": "Advania Norge",
  "company_ln_id": "98",
  "position": "Sales & Partner Manager",
  "headline": "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge",
  "about": "Busy times with contributing to our customers' cloud journey...",
  "avatar_url": "https://example.com/avatar.jpg",
  "ln_id": "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
  "sn_id": "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI",
  "linkedin": "christina-sletner-b4481a2",
  "facebook": "christina-sletner",
  "twitter": "christina-sletner",
  "work_email": "christina.sletner@advania.no",
  "personal_email": "christina88@yahoo.com",
  "work_phone_number": "+123456789",
  "personal_phone_number": "+123456789",
  "connections_number": 500,
  "followers_number": 1000,
  "primary_language": "en",
  "supported_languages": [
    "en",
    "no"
  ],
  "has_open_profile": 1,
  "has_verified_profile": 1,
  "has_premium": 1,
  "experience": [
    { … }
  ],
  "posts": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "skills": [
    "Project Management",
    "Sales",
    "ERP Systems"
  ],
  "top_voices": [
    "Thought Leader 1",
    "Influencer 2"
  ],
  "raw_address": "Oslo, Oslo, Norway",
  "location": [
    { … }
  ],
  "tags": [
    "uuid-uuid-uuid-uuid-example",
    "uuid-uuid-uuid-uuid-example"
  ],
  "status": "ok",
  "linkedin_status": "active",
  "email_status": "verified",
  "unread_counts": [
    { … }
  ],
  "last_automation_approve_at": "2023-07-21T10:15:30Z",
  "created_at": "2022-12-11T10:00:00Z",
  "updated_at": "2022-12-11T11:00:00Z"
}

Update contact by UUID

Request

Update Contact by UUID

Path
uuidstringrequired

UUID of Contact

Bodyapplication/jsonrequired
first_namestring

The contact's first name.

Example: "John"
last_namestring

The contact's last name.

Example: "Doe"
company_namestring

The name of the company the contact is associated with.

Example: "ExampleCorp"
ln_idstring or null
Example: "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
sn_idstring or null
Example: "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"
linkedinstring or null
Example: "christina-sletner-b4481a2"
emailstring(email)

A contactable email address for the contact.

Example: "john.doe@example.com"
aboutstring

Description of contact

Example: "john.doe@example.com"
domainstring

Contact's company domain to find his email

Example: "somecoolcompany.com"
headlinestring or null
Example: "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge"
positionstring or null
Example: "Sales & Partner Manager"
raw_addressstring or null
Example: "Oslo, Oslo, Norway"
curl -i -X PUT \
  'https://amazing.getsales.io/leads/api/leads/{uuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "company_name": "ExampleCorp",
    "ln_id": "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
    "sn_id": "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI",
    "linkedin": "christina-sletner-b4481a2",
    "email": "john.doe@example.com",
    "about": "john.doe@example.com",
    "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"
  }'

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
user_idinteger or null
Example: 1
sender_profile_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
list_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
data_source_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
pipeline_stage_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
company_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
namestring or null
Example: "Christina Sletner"
first_namestring or null
Example: "Christina"
last_namestring or null
Example: "Sletner"
company_namestring or null
Example: "Advania Norge"
company_ln_idstring or null
Example: "98"
positionstring or null
Example: "Sales & Partner Manager"
headlinestring or null
Example: "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge"
aboutstring or null
Example: "Busy times with contributing to our customers' cloud journey..."
avatar_urlstring or null
Example: "https://example.com/avatar.jpg"
ln_idstring or null
Example: "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
sn_idstring or null
Example: "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"
linkedinstring or null
Example: "christina-sletner-b4481a2"
facebookstring or null
Example: "christina-sletner"
twitterstring or null
Example: "christina-sletner"
work_emailstring or null
Example: "christina.sletner@advania.no"
personal_emailstring or null
Example: "christina88@yahoo.com"
work_phone_numberstring or null
Example: "+123456789"
personal_phone_numberstring or null
Example: "+123456789"
connections_numberinteger or null
Example: 500
followers_numberinteger or null
Example: 1000
primary_languagestring or null
Example: "en"
supported_languagesArray of strings or null
Example: ["en","no"]
has_open_profileinteger or null
Example: 1
has_verified_profileinteger or null
Example: 1
has_premiuminteger or null
Example: 1
experienceArray of objects or null
postsArray of objects or null
educationsArray of objects or null
skillsArray of strings or null
Example: ["Project Management","Sales","ERP Systems"]
top_voicesArray of strings or null
Example: ["Thought Leader 1","Influencer 2"]
raw_addressstring or null
Example: "Oslo, Oslo, Norway"
locationArray of objects or null
tagsArray of strings or null
Example: ["uuid-uuid-uuid-uuid-example","uuid-uuid-uuid-uuid-example"]
statusstring
Example: "ok"
linkedin_statusstring
Example: "active"
email_statusstring or null
Example: "verified"
unread_countsArray of objects
last_automation_approve_atstring or null(date-time)
Example: "2023-07-21T10:15:30Z"
created_atstring or null(date-time)
Example: "2022-12-11T10:00:00Z"
updated_atstring or null(date-time)
Example: "2022-12-11T11:00:00Z"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "user_id": 1,
  "sender_profile_uuid": "uuid-uuid-uuid-uuid-example",
  "list_uuid": "uuid-uuid-uuid-uuid-example",
  "data_source_uuid": "uuid-uuid-uuid-uuid-example",
  "pipeline_stage_uuid": "uuid-uuid-uuid-uuid-example",
  "company_uuid": "uuid-uuid-uuid-uuid-example",
  "name": "Christina Sletner",
  "first_name": "Christina",
  "last_name": "Sletner",
  "company_name": "Advania Norge",
  "company_ln_id": "98",
  "position": "Sales & Partner Manager",
  "headline": "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge",
  "about": "Busy times with contributing to our customers' cloud journey...",
  "avatar_url": "https://example.com/avatar.jpg",
  "ln_id": "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
  "sn_id": "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI",
  "linkedin": "christina-sletner-b4481a2",
  "facebook": "christina-sletner",
  "twitter": "christina-sletner",
  "work_email": "christina.sletner@advania.no",
  "personal_email": "christina88@yahoo.com",
  "work_phone_number": "+123456789",
  "personal_phone_number": "+123456789",
  "connections_number": 500,
  "followers_number": 1000,
  "primary_language": "en",
  "supported_languages": [
    "en",
    "no"
  ],
  "has_open_profile": 1,
  "has_verified_profile": 1,
  "has_premium": 1,
  "experience": [
    { … }
  ],
  "posts": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "skills": [
    "Project Management",
    "Sales",
    "ERP Systems"
  ],
  "top_voices": [
    "Thought Leader 1",
    "Influencer 2"
  ],
  "raw_address": "Oslo, Oslo, Norway",
  "location": [
    { … }
  ],
  "tags": [
    "uuid-uuid-uuid-uuid-example",
    "uuid-uuid-uuid-uuid-example"
  ],
  "status": "ok",
  "linkedin_status": "active",
  "email_status": "verified",
  "unread_counts": [
    { … }
  ],
  "last_automation_approve_at": "2023-07-21T10:15:30Z",
  "created_at": "2022-12-11T10:00:00Z",
  "updated_at": "2022-12-11T11:00:00Z"
}

Delete a Contact

Request

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.

Path
uuidstringrequired

Unique identifier of the contact to be deleted.

curl -i -X DELETE \
  'https://amazing.getsales.io/leads/api/leads/{uuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The contact was deleted successfully. No content is returned.

Response
No content

Create or Update a contact

Request

Creates or updates a contact in the specified list. If the contact exists and update_if_exists is true, it will be updated. Optionally, the contact can also be moved to the specified list.

Bodyapplication/jsonrequired
leadobjectrequired

The contact data to be created and attached to the automation.

lead.​linkedin_idstringrequired

The contact's LinkedIn ID or profile handle.

Example: "john-doe-123456 or ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
lead.​first_namestring

The contact's first name.

Example: "John"
lead.​last_namestring

The contact's last name.

Example: "Doe"
lead.​company_namestring

The name of the company the contact is associated with.

Example: "ExampleCorp"
lead.​ln_idstring or null
Example: "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
lead.​sn_idstring or null
Example: "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"
lead.​linkedinstring or null
Example: "christina-sletner-b4481a2"
lead.​emailstring(email)

A contactable email address for the contact.

Example: "john.doe@example.com"
lead.​aboutstring

Description of contact

Example: "john.doe@example.com"
lead.​domainstring

Contact's company domain to find his email

Example: "somecoolcompany.com"
lead.​headlinestring or null
Example: "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge"
lead.​positionstring or null
Example: "Sales & Partner Manager"
lead.​raw_addressstring or null
Example: "Oslo, Oslo, Norway"
custom_fieldsobject

Custom fields and their values.

Example: {"field_position":"CTO","field_experience":"10 years"}
list_uuidstringrequired

UUID of the target list.

Example: "uuid-uuid-uuid-uuid"
update_if_existsboolean

If true (default), updates contact if it already exists.

Default true
Example: true
move_to_listboolean

If true, moves the existing contact to the specified list.

Default false
Example: false
curl -i -X POST \
  https://amazing.getsales.io/leads/api/leads/upsert \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "lead": {
      "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": "john.doe@example.com",
      "about": "john.doe@example.com",
      "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": {
      "field_position": "CTO",
      "field_experience": "10 years"
    },
    "list_uuid": "uuid-uuid-uuid-uuid",
    "update_if_exists": true,
    "move_to_list": false
  }'

Responses

Successful contact upsert response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
user_idinteger or null
Example: 1
sender_profile_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
list_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
data_source_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
pipeline_stage_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
company_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
namestring or null
Example: "Christina Sletner"
first_namestring or null
Example: "Christina"
last_namestring or null
Example: "Sletner"
company_namestring or null
Example: "Advania Norge"
company_ln_idstring or null
Example: "98"
positionstring or null
Example: "Sales & Partner Manager"
headlinestring or null
Example: "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge"
aboutstring or null
Example: "Busy times with contributing to our customers' cloud journey..."
avatar_urlstring or null
Example: "https://example.com/avatar.jpg"
ln_idstring or null
Example: "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"
sn_idstring or null
Example: "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"
linkedinstring or null
Example: "christina-sletner-b4481a2"
facebookstring or null
Example: "christina-sletner"
twitterstring or null
Example: "christina-sletner"
work_emailstring or null
Example: "christina.sletner@advania.no"
personal_emailstring or null
Example: "christina88@yahoo.com"
work_phone_numberstring or null
Example: "+123456789"
personal_phone_numberstring or null
Example: "+123456789"
connections_numberinteger or null
Example: 500
followers_numberinteger or null
Example: 1000
primary_languagestring or null
Example: "en"
supported_languagesArray of strings or null
Example: ["en","no"]
has_open_profileinteger or null
Example: 1
has_verified_profileinteger or null
Example: 1
has_premiuminteger or null
Example: 1
experienceArray of objects or null
postsArray of objects or null
educationsArray of objects or null
skillsArray of strings or null
Example: ["Project Management","Sales","ERP Systems"]
top_voicesArray of strings or null
Example: ["Thought Leader 1","Influencer 2"]
raw_addressstring or null
Example: "Oslo, Oslo, Norway"
locationArray of objects or null
tagsArray of strings or null
Example: ["uuid-uuid-uuid-uuid-example","uuid-uuid-uuid-uuid-example"]
statusstring
Example: "ok"
linkedin_statusstring
Example: "active"
email_statusstring or null
Example: "verified"
unread_countsArray of objects
last_automation_approve_atstring or null(date-time)
Example: "2023-07-21T10:15:30Z"
created_atstring or null(date-time)
Example: "2022-12-11T10:00:00Z"
updated_atstring or null(date-time)
Example: "2022-12-11T11:00:00Z"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "user_id": 1,
  "sender_profile_uuid": "uuid-uuid-uuid-uuid-example",
  "list_uuid": "uuid-uuid-uuid-uuid-example",
  "data_source_uuid": "uuid-uuid-uuid-uuid-example",
  "pipeline_stage_uuid": "uuid-uuid-uuid-uuid-example",
  "company_uuid": "uuid-uuid-uuid-uuid-example",
  "name": "Christina Sletner",
  "first_name": "Christina",
  "last_name": "Sletner",
  "company_name": "Advania Norge",
  "company_ln_id": "98",
  "position": "Sales & Partner Manager",
  "headline": "Sales & Partner Manager I ERP-/Dynamics 365 Finance/OnSite 365 at Advania Norge",
  "about": "Busy times with contributing to our customers' cloud journey...",
  "avatar_url": "https://example.com/avatar.jpg",
  "ln_id": "ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U",
  "sn_id": "ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI",
  "linkedin": "christina-sletner-b4481a2",
  "facebook": "christina-sletner",
  "twitter": "christina-sletner",
  "work_email": "christina.sletner@advania.no",
  "personal_email": "christina88@yahoo.com",
  "work_phone_number": "+123456789",
  "personal_phone_number": "+123456789",
  "connections_number": 500,
  "followers_number": 1000,
  "primary_language": "en",
  "supported_languages": [
    "en",
    "no"
  ],
  "has_open_profile": 1,
  "has_verified_profile": 1,
  "has_premium": 1,
  "experience": [
    { … }
  ],
  "posts": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "skills": [
    "Project Management",
    "Sales",
    "ERP Systems"
  ],
  "top_voices": [
    "Thought Leader 1",
    "Influencer 2"
  ],
  "raw_address": "Oslo, Oslo, Norway",
  "location": [
    { … }
  ],
  "tags": [
    "uuid-uuid-uuid-uuid-example",
    "uuid-uuid-uuid-uuid-example"
  ],
  "status": "ok",
  "linkedin_status": "active",
  "email_status": "verified",
  "unread_counts": [
    { … }
  ],
  "last_automation_approve_at": "2023-07-21T10:15:30Z",
  "created_at": "2022-12-11T10:00:00Z",
  "updated_at": "2022-12-11T11:00:00Z"
}

Automations

Automations API

Operations

Unibox

Unified inbox API

Operations

Sender Profiles

Sender profiles API

Operations

Lists

Operations