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

Sender Profiles

Sender profiles API

Operations

List of Sender Profiles

Request

List of Sender Profiles

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/sender-profiles?assignee_user_id=string&first_name=string&label=string&last_name=string&limit=20&linkedin_account_uuid=string&linkedin_browser_id=string&mailbox_uuid=string&offset=0&order_field=created_at&order_type=asc&q=string&status=string&user_id=string&uuid=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

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

Create Sender Profile

Request

Create Sender Profile

Bodyapplication/jsonrequired
assignee_user_idinteger
Example: 1
first_namestring
Example: "John"
last_namestring
Example: "Doe"
labelstring
Example: "USA media owners"
curl -i -X POST \
  https://amazing.getsales.io/flows/api/sender-profiles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignee_user_id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "label": "USA media owners"
  }'

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
linkedin_server_idinteger
Example: 1
linkedin_browser_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
linkedin_account_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
mailbox_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
assignee_user_idinteger
Example: 1
first_namestring
Example: "John"
last_namestring
Example: "Doe"
labelstring
Example: "USA media owners"
statusstring
Example: "enabled"
user_idinteger
Example: 1
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "linkedin_server_id": 1,
  "linkedin_browser_uuid": "uuid-uuid-uuid-uuid-example",
  "linkedin_account_uuid": "uuid-uuid-uuid-uuid-example",
  "mailbox_uuid": "uuid-uuid-uuid-uuid-example",
  "assignee_user_id": 1,
  "first_name": "John",
  "last_name": "Doe",
  "label": "USA media owners",
  "status": "enabled",
  "user_id": 1
}

Get Sender Profile by Uuid

Request

Get Sender Profile by Uuid

Path
senderProfileUuidstringrequired
curl -i -X GET \
  'https://amazing.getsales.io/flows/api/sender-profiles/{senderProfileUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
linkedin_server_idinteger
Example: 1
linkedin_browser_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
linkedin_account_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
mailbox_uuidstring
Example: "uuid-uuid-uuid-uuid-example"
assignee_user_idinteger
Example: 1
first_namestring
Example: "John"
last_namestring
Example: "Doe"
labelstring
Example: "USA media owners"
statusstring
Example: "enabled"
user_idinteger
Example: 1
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "linkedin_server_id": 1,
  "linkedin_browser_uuid": "uuid-uuid-uuid-uuid-example",
  "linkedin_account_uuid": "uuid-uuid-uuid-uuid-example",
  "mailbox_uuid": "uuid-uuid-uuid-uuid-example",
  "assignee_user_id": 1,
  "first_name": "John",
  "last_name": "Doe",
  "label": "USA media owners",
  "status": "enabled",
  "user_id": 1
}

Lists

Operations