Skip to content

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

Automations

Automations API

Operations

List of automations

Request

List of Automations

Security
bearerAuth
Query
limitinteger(int32)

How many items to return at one time (default 20)

Example: limit=20
offsetinteger(int32)

Data offset (default 0)

Example: offset=0
order_fieldstring

Field of sorting

Example: order_field=created_at
order_typestring

Type of sorting 'asc'(default) or 'desc'

Enum"asc""desc"
Example: order_type=asc
filterobject

Search filters, supported (q)

curl -i -X GET \
  'https://amazing.getsales.io/flows/api/flows?limit=20&offset=0&order_field=created_at&order_type=asc&q=string&uuid=string&flow_workspace_uuid=string&flow_version_uuid=string&status=string&is_public=string&user_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
dataArray of objects(flow)
limitinteger
Example: 20
offsetinteger
Example: 0
totalinteger
Example: 199
has_moreboolean
Example: true
Response
application/json
{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "total": 199,
  "has_more": true
}

Start a automation

Request

Start a Automation

Security
bearerAuth
Path
flowUuidstringrequired

The UUID of the automation to start.

curl -i -X PUT \
  'https://amazing.getsales.io/flows/api/flows/{flowUuid}/start' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully started the Automation.

Bodyapplication/json
uuidstringrequired
Example: "uuid-uuid-uuid-uuid-example"
public_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
team_idintegerrequired
Example: 1
namestringrequired
Example: "CMO Germany"
flow_workspace_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
flow_version_uuidstringrequired
Example: "uuid-uuid-uuid-uuid-example"
scheduleobjectrequired
schedule.​timezonestringrequired
Example: "Asia/Omsk"
schedule.​use_lead_timezoneboolean
Example: false
schedule.​timeblocksArray of objectsrequired
schedule.​timeblocks[].​dowinteger
Example: 0
schedule.​timeblocks[].​frominteger
Example: 840
schedule.​timeblocks[].​tointeger
Example: 1080
descriptionstring or null
Example: "This is a flow description"
priorityintegerrequired
Example: 10
statusstringrequired
Example: "on"
is_publicbooleanrequired
Example: true
user_idintegerrequired
Example: 1
created_atstring(date-time)
Example: "2024-12-11T12:34:56Z"
updated_atstring(date-time)
Example: "2024-12-11T12:34:56Z"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "public_uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "name": "CMO Germany",
  "flow_workspace_uuid": "uuid-uuid-uuid-uuid-example",
  "flow_version_uuid": "uuid-uuid-uuid-uuid-example",
  "schedule": {
    "timezone": "Asia/Omsk",
    "use_lead_timezone": false,
    "timeblocks": [ … ]
  },
  "description": "This is a flow description",
  "priority": 10,
  "status": "on",
  "is_public": true,
  "user_id": 1,
  "created_at": "2024-12-11T12:34:56Z",
  "updated_at": "2024-12-11T12:34:56Z"
}

Stop an automation

Request

Stop an Automation

Security
bearerAuth
Path
flowUuidstringrequired

The UUID of the automation to stop.

curl -i -X PUT \
  'https://amazing.getsales.io/flows/api/flows/{flowUuid}/stop' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully stopped the Automation.

Bodyapplication/json
uuidstringrequired
Example: "uuid-uuid-uuid-uuid-example"
public_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
team_idintegerrequired
Example: 1
namestringrequired
Example: "CMO Germany"
flow_workspace_uuidstring or null
Example: "uuid-uuid-uuid-uuid-example"
flow_version_uuidstringrequired
Example: "uuid-uuid-uuid-uuid-example"
scheduleobjectrequired
schedule.​timezonestringrequired
Example: "Asia/Omsk"
schedule.​use_lead_timezoneboolean
Example: false
schedule.​timeblocksArray of objectsrequired
schedule.​timeblocks[].​dowinteger
Example: 0
schedule.​timeblocks[].​frominteger
Example: 840
schedule.​timeblocks[].​tointeger
Example: 1080
descriptionstring or null
Example: "This is a flow description"
priorityintegerrequired
Example: 10
statusstringrequired
Example: "on"
is_publicbooleanrequired
Example: true
user_idintegerrequired
Example: 1
created_atstring(date-time)
Example: "2024-12-11T12:34:56Z"
updated_atstring(date-time)
Example: "2024-12-11T12:34:56Z"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "public_uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "name": "CMO Germany",
  "flow_workspace_uuid": "uuid-uuid-uuid-uuid-example",
  "flow_version_uuid": "uuid-uuid-uuid-uuid-example",
  "schedule": {
    "timezone": "Asia/Omsk",
    "use_lead_timezone": false,
    "timeblocks": [ … ]
  },
  "description": "This is a flow description",
  "priority": 10,
  "status": "on",
  "is_public": true,
  "user_id": 1,
  "created_at": "2024-12-11T12:34:56Z",
  "updated_at": "2024-12-11T12:34:56Z"
}

Add contact to automation

Request

Add Contact to Automation

Security
bearerAuth
Path
flowUuidstringrequired

UUID of Automation

leadUuidstringrequired

UUID of Contact

curl -i -X POST \
  'https://amazing.getsales.io/flows/api/flows/{flowUuid}/leads/{leadUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Add a new contact to automation

Request

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 skip_if_lead_exists is provided only new contacts will be added to automation, otherwise the request returns a reason "skipped."

Security
bearerAuth
Path
flowUuidstring(uuid)required

The UUID of the automation to which the contact should be added.

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_lead_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
flow_segment_idinteger

The ID of a specific automation segment. Defaults to 1 if not provided.

Example: 1
skip_if_lead_existsboolean

If true and the contact already exists, it won't be added to automation.

Example: true
curl -i -X POST \
  'https://amazing.getsales.io/flows/api/flows/{flowUuid}/add-new-lead' \
  -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_lead_if_exists": true,
    "move_to_list": false,
    "flow_segment_id": 1,
    "skip_if_lead_exists": true
  }'

Responses

The contact was successfully added to the automation, and no content is returned.

Response
No content

Cancel Contact from Specific Automations

Request

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".

Security
bearerAuth
Path
leadUuidstringrequired

Unique identifier of the lead to be cancelled from specific automation.

Bodyapplication/json

JSON payload containing an array of automation flow UUIDs from which to cancel the contact.

flow_uuidsArray of arrays

An array of flow UUIDs.

curl -i -X PUT \
  'https://amazing.getsales.io/flows/api/flows/leads/{leadUuid}/cancel' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "flow_uuids": []
  }'

Responses

Cancellation jobs dispatched successfully. No content returned.

Response
No content

Cancel Contact from All Automations

Request

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".

Security
bearerAuth
Path
leadUuidstringrequired

Unique identifier of the lead to be cancelled from all flows.

curl -i -X PUT \
  'https://amazing.getsales.io/flows/api/flows/leads/{leadUuid}/cancel-all' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Cancellation jobs dispatched successfully. No content returned.

Response
No content

Unibox

Unified inbox API

Operations

Sender Profiles

Sender profiles API

Operations

Lists

Operations