Skip to main content
GET
/
contacts
Get Contacts
curl --request GET \
  --url https://public.watermelon.ai/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "company_id": 123,
    "first_name": "Walter",
    "last_name": "Melon",
    "email_address": "walter.melon@example.co",
    "telephone_number": "+316123456789",
    "avatar": "https://unsplash.com/photos/hUkZv0Y47Ic",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "offline",
    "from_integration": true,
    "integration": "Zapier",
    "from_whatsapp": true,
    "from_email": true,
    "fields": [
      {
        "id": 1,
        "company_id": 123,
        "icon": "information",
        "name": "Order number",
        "type": "text",
        "order": 123,
        "value": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "is_unique": true
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
withoutAnonymous
boolean
default:false

Should the list return anonymous contacts?

​
page
integer

The page number

Required range: x >= 0
​
limit
integer
default:25

The numbers of items per page.

Required range: 1 <= x <= 100
​
from
string<date-time>

The begin of the date range

​
to
string<date-time>

The end of the date range

Response

Contacts list

​
id
integer
Example:

1

​
company_id
integer
​
first_name
string
Example:

"Walter"

​
last_name
string
Example:

"Melon"

​
email_address
string
Example:

"walter.melon@example.co"

​
telephone_number
string
Example:

"+316123456789"

​
avatar
string
Example:

"https://unsplash.com/photos/hUkZv0Y47Ic"

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
status
enum<string>
Available options:
online,
offline,
minimized,
disconnected
Example:

"offline"

​
from_integration
boolean
​
integration
string
Example:

"Zapier"

​
from_whatsapp
boolean
​
from_email
boolean
​
fields
object[]