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

Unibox

Unified inbox API

Operations

List of LinkedIn Messages

Request

List of LinkedIn messages

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

curl -i -X GET \
  'https://amazing.getsales.io/flows/api/linkedin-messages?filter%5Bautomation%5D=string&filter%5Blead_uuid%5D=string&filter%5Blinkedin_account_uuid%5D=string&filter%5Blinkedin_conversation_uuid%5D=string&filter%5Bmessage_hash%5D=string&filter%5Bq%5D=string&filter%5Bsender_profile_uuid%5D=string&filter%5Bstatus%5D=string&filter%5Btask_pipeline_uuid%5D=string&filter%5Btemplate_uuid%5D=string&filter%5Btype%5D=string&filter%5Buser_id%5D=string&filter%5Buuid%5D=string&limit=20&offset=0&order_field=created_at&order_type=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

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

Send LinkedIn Message

Request

Send LinkedIn Message

Bodyapplication/jsonrequired
sender_profile_uuidany
Example: "{{_.senderProfileUuid}}"
lead_uuidstring
Example: "{{_.leadUuid}}"
template_uuidstring
Example: "{{_.templateUuid}}"
textstring
Example: "Hello John, how are you?"
attachmentsArray of arrays
curl -i -X POST \
  https://amazing.getsales.io/flows/api/linkedin-messages \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender_profile_uuid": "{{_.senderProfileUuid}}",
    "lead_uuid": "{{_.leadUuid}}",
    "template_uuid": "{{_.templateUuid}}",
    "text": "Hello John, how are you?",
    "attachments": []
  }'

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
sender_profile_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
linkedin_account_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
linkedin_conversation_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
lead_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
task_pipeline_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
template_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
message_hashstring
Example: "2-N2RmYmExZjMtOTJhMS00ZmM1LWIyYmYtOTlhMjhmMzU1MTU4XzAxMA=="
textstring
Example: "Hello there, this is mr. Twister"
custom_contentArray of arrays
attachmentsArray of arrays
typestring
Example: "outbox"
automationstring
Example: "auto"
statusstring
Example: "new"
fail_reasonstring
Example: "Some reason of failing"
read_atstring
Example: "2022-05-20T20:49:39.000000Z"
sent_atstring
Example: "2022-05-20T20:49:39.000000Z"
user_idinteger
Example: 1
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "sender_profile_uuid": "uuid-uuid-uuid-uuid-example",
  "linkedin_account_uuid": "uuid-uuid-uuid-uuid-example",
  "linkedin_conversation_uuid": "uuid-uuid-uuid-uuid-example",
  "lead_uuid": "uuid-uuid-uuid-uuid-example",
  "task_pipeline_uuid": "uuid-uuid-uuid-uuid-example",
  "template_uuid": "uuid-uuid-uuid-uuid-example",
  "message_hash": "2-N2RmYmExZjMtOTJhMS00ZmM1LWIyYmYtOTlhMjhmMzU1MTU4XzAxMA==",
  "text": "Hello there, this is mr. Twister",
  "custom_content": [],
  "attachments": [],
  "type": "outbox",
  "automation": "auto",
  "status": "new",
  "fail_reason": "Some reason of failing",
  "read_at": "2022-05-20T20:49:39.000000Z",
  "sent_at": "2022-05-20T20:49:39.000000Z",
  "user_id": 1
}

List of Emails

Request

List of emails

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/emails/api/emails?bounced_by_uuid=string&created_at=string&email_body_uuid=string&flow_node_id=string&flow_uuid=string&from_email=string&from_name=string&gpt_prompt_uuid=string&lead_uuid=string&limit=20&mailbox_uuid=string&offset=0&order_field=created_at&order_type=asc&q=string&replied_to_uuid=string&sender_profile_uuid=string&sending_attempts=string&sent_at=string&status=string&subject=string&task_pipeline_uuid=string&team_id=string&template_uuid=string&thread_uuid=string&to_email=string&to_name=string&type=string&updated_at=string&user_id=string&uuid=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

Bodyapplication/jsonArray [
uuidstring(uuid)
team_idinteger(int32)
user_idinteger(int32)
sender_profile_uuidstring(uuid)
mailbox_uuidstring(uuid)
email_body_uuidstring(uuid)
flow_uuidstring(uuid)
flow_node_idinteger(int32)
task_pipeline_uuidstring(uuid)
template_uuidstring(uuid)
gpt_prompt_uuidstring(uuid)
email_uidstring
email_idstring
folderstring
lead_uuidstring(uuid)
statusstring
replied_to_uuidstring(uuid)
bounced_by_uuidstring(uuid)
typestring
from_namestring
from_emailstring
to_namestring
to_emailstring
ccArray of strings
bccArray of strings
subjectstring
headersArray of strings
sending_attemptsinteger(int32)
sent_atstring(date-time)
created_atstring(date-time)
updated_atstring(date-time)
]
Response
application/json
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "team_id": 0,
    "user_id": 0,
    "sender_profile_uuid": "5d4d9d60-1e0b-400d-94d5-85c4b6a306f6",
    "mailbox_uuid": "d68f8f4c-fb28-4e30-b007-98bce1cb2c0d",
    "email_body_uuid": "1d55729a-d2ea-41f8-ab9d-f02ee9e2eb16",
    "flow_uuid": "11840a54-032e-452f-857e-bb369a5e7afa",
    "flow_node_id": 0,
    "task_pipeline_uuid": "4db99209-acb6-4477-a7d7-01504f092141",
    "template_uuid": "bc655329-a633-48b7-8552-661ece461685",
    "gpt_prompt_uuid": "24d55385-c52a-4e00-8cec-0e2d26632e8d",
    "email_uid": "string",
    "email_id": "string",
    "folder": "string",
    "lead_uuid": "10b13691-d53f-44ed-aea6-f585d60459aa",
    "status": "string",
    "replied_to_uuid": "368fd351-527e-488b-8949-d5667d0de6f9",
    "bounced_by_uuid": "97ba3dcc-25e4-4028-a3f6-3cb32a51331d",
    "type": "string",
    "from_name": "string",
    "from_email": "string",
    "to_name": "string",
    "to_email": "string",
    "cc": [ … ],
    "bcc": [ … ],
    "subject": "string",
    "headers": [ … ],
    "sending_attempts": 0,
    "sent_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Send Email

Request

Send a new email

Bodyapplication/jsonrequired
sender_profile_uuidstring(uuid)
lead_uuidstring(uuid)
from_namestring
from_emailstring
to_namestring
to_emailstring
ccArray of strings
bccArray of strings
subjectstring
curl -i -X POST \
  https://amazing.getsales.io/emails/api/emails/send-email \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender_profile_uuid": "5d4d9d60-1e0b-400d-94d5-85c4b6a306f6",
    "lead_uuid": "10b13691-d53f-44ed-aea6-f585d60459aa",
    "from_name": "string",
    "from_email": "string",
    "to_name": "string",
    "to_email": "string",
    "cc": [
      "string"
    ],
    "bcc": [
      "string"
    ],
    "subject": "string"
  }'

Responses

Successfully created

Bodyapplication/json
emailDomainobject(email)
emailBodyDomainobject(email-body)
Response
application/json
{
  "emailDomain": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "team_id": 0,
    "user_id": 0,
    "sender_profile_uuid": "5d4d9d60-1e0b-400d-94d5-85c4b6a306f6",
    "mailbox_uuid": "d68f8f4c-fb28-4e30-b007-98bce1cb2c0d",
    "email_body_uuid": "1d55729a-d2ea-41f8-ab9d-f02ee9e2eb16",
    "flow_uuid": "11840a54-032e-452f-857e-bb369a5e7afa",
    "flow_node_id": 0,
    "task_pipeline_uuid": "4db99209-acb6-4477-a7d7-01504f092141",
    "template_uuid": "bc655329-a633-48b7-8552-661ece461685",
    "gpt_prompt_uuid": "24d55385-c52a-4e00-8cec-0e2d26632e8d",
    "email_uid": "string",
    "email_id": "string",
    "folder": "string",
    "lead_uuid": "10b13691-d53f-44ed-aea6-f585d60459aa",
    "status": "string",
    "replied_to_uuid": "368fd351-527e-488b-8949-d5667d0de6f9",
    "bounced_by_uuid": "97ba3dcc-25e4-4028-a3f6-3cb32a51331d",
    "type": "string",
    "from_name": "string",
    "from_email": "string",
    "to_name": "string",
    "to_email": "string",
    "cc": [ … ],
    "bcc": [ … ],
    "subject": "string",
    "headers": [ … ],
    "sending_attempts": 0,
    "sent_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "emailBodyDomain": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "team_id": 0,
    "body": "string",
    "attachments": [ … ],
    "subject": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Sender Profiles

Sender profiles API

Operations

Lists

Operations