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

Unibox

Unified inbox API

Operations

Sender Profiles

Sender profiles API

Operations

List of Sender Profiles

Request

List of Sender Profiles

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

Security
bearerAuth
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

Security
bearerAuth
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
}

Connect Sender Profile (with external GoLogin)

Request

Creates a new Sender Profile with the provided first/last name, schedule and Gologin ID. Automatically connects the profile to a LinkedIn Browser using the provided GoLogin external ID. Requires authentication and active subscription. Will fail if the sender profile limit is reached.

Security
bearerAuth
Bodyapplication/jsonrequired
first_namestring<= 255 charactersrequired

First name of the sender.

Example: "John"
last_namestring<= 255 charactersrequired

Last name of the sender.

Example: "Doe"
labelstring or null

Optional custom label for identification.

Example: "Main LinkedIn Profile"
scheduleobject or null
smart_limits_enabledboolean or null

Enables smart limits for automation.

Example: true
notification_emailsArray of strings or null(email)
Example: ["alerts@example.com","manager@example.com"]
gologin_external_idstringrequired

External ID from GoLogin used to create the browser profile.

Example: "gl-profile-123456"
browser_ownerstring or null

Optional owner of the browser profile.

Example: "customer"
curl -i -X POST \
  https://amazing.getsales.io/flows/client-api/sender-profiles/connect-external \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "gologin_external_id": "gl-profile-123456"
  }'

Responses

Sender Profile created

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": "b4c86e35-3a7d-4377-9d0c-bfab64f6f9e1",
  "team_id": 42,
  "linkedin_browser_id": 15,
  "linkedin_account_uuid": null,
  "mailbox_uuid": null,
  "assignee_user_id": 101,
  "first_name": "Jane",
  "last_name": "Smith",
  "label": "Jane's LinkedIn",
  "schedule": {
    "timezone": "UTC",
    "timeblocks": [ … ]
  },
  "smart_limits_enabled": true,
  "avatar_url": null,
  "status": "enabled",
  "user_id": 1001,
  "hold_tasks_till": null,
  "last_automation_server_id": null,
  "notification_emails": [
    "jane@example.com",
    "team@example.com"
  ],
  "created_at": "2025-09-10T12:00:00Z",
  "updated_at": "2025-09-10T12:00:00Z"
}

Lists

Operations