Skip to main content
GET
/
api
/
v1
/
contacts
Get Contacts
curl --request GET \
  --url http://localhost:8080/api/v1/contacts \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": "success",
  "data": {
    "results": [
      {
        "id": 163,
        "type": "contact",
        "first_name": "PayPal",
        "last_name": "",
        "email": "donotreply@paypal.com",
        "enabled": true,
        "avatar_url": null,
        "created_at": "2025-09-14T18:53:01.172243Z",
        "updated_at": "2025-09-14T18:53:01.172243Z"
      }
    ],
    "total": 39,
    "per_page": 100,
    "total_pages": 1,
    "page": 1
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Query Parameters

​
page
integer
default:1

Page number (defaults to 1)

Required range: x >= 1
​
page_size
integer
default:30

Number of items per page (defaults to 30, max 100)

Required range: 1 <= x <= 100

Response

List of contacts

​
status
string
Example:

"success"

​
data
object