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

Lists

Operations

List of Lists

Request

List of Lists

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
curl -i -X GET \
  'https://amazing.getsales.io/leads/api/lists?limit=20&offset=0&order_field=created_at&order_type=asc&q=string&uuid=string&name=string&user_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/jsonArray [
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
namestring
Example: "CMO Germany"
]
Response
application/json
[
  {
    "uuid": "uuid-uuid-uuid-uuid-example",
    "team_id": 1,
    "name": "CMO Germany"
  }
]

Create New List

Request

Create New List

Security
bearerAuth
Bodyapplication/jsonrequired

List fields

namestring
Example: "CMO Germany"
curl -i -X POST \
  https://amazing.getsales.io/leads/api/lists \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "CMO Germany"
  }'

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
namestring
Example: "CMO Germany"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "name": "CMO Germany"
}

Get List by UUID

Request

Get List by UUID

Security
bearerAuth
Path
uuidstringrequired

UUID of List

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

Responses

Successful Response

Bodyapplication/json
uuidstring
Example: "uuid-uuid-uuid-uuid-example"
team_idinteger
Example: 1
namestring
Example: "CMO Germany"
Response
application/json
{
  "uuid": "uuid-uuid-uuid-uuid-example",
  "team_id": 1,
  "name": "CMO Germany"
}