Get a list of contacts | Solvimon

curl https://test.api.solvimon.com/v1/contacts \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "reference": "contact_001",
      "customer_id": "cust_987654321",
      "email": "alice.johnson@example.com",
      "object_type": "contact",
      "id": "c1234567-89ab-4def-0123-456789abcdef",
      "name": {
        "first_name": "Alice",
        "last_name": "Johnson",
        "infix": "van"
      },
      "notification_preferences": [
        {
          "type": "INVOICE",
          "channels": [
            {
              "type": "EMAIL",
              "enabled": true
            }
          ]
        }
      ],
      "custom_fields": [
        {
          "id": "cf_123abc",
          "reference": "preferred_language",
          "value": "English",
          "values": [
            "English",
            "Dutch"
          ],
          "integration_details": {
            "payment_gateway_variant": "STRIPE",
            "id": "int_456def",
            "reference": "stripe_payment",
            "adyen": {
              "recurring_detail_reference": "recurring_789xyz"
            },
            "stripe": {
              "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3aXb7Y2Z"
            }
          }
        }
      ],
      "linked_integrations": [
        {
          "id": "int_789ghi",
          "link_details": [
            {
              "url": "https://dashboard.stripe.com/payments/pm_1GqIC8Lz0qyl6XeW3aXb7Y2Z",
              "custom_field_name": "stripe_payment_method"
            }
          ]
        }
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "links": {
    "first": "https://api.solvimon.com/v1/contacts?page=1&limit=10",
    "current": "https://api.solvimon.com/v1/contacts?page=1&limit=10",
    "next": "https://api.solvimon.com/v1/contacts?page=2&limit=10"
  },
  "total_number_of_pages": 5
}

Requires the CONTACT.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

customer_idstringOptional

The resource id of the customer.

pageintegerOptional

The page which is going to be shown

limitintegerOptional

The amount of records shown in the list

custom_fieldstringOptional

Filter the response by a custom field value.

Response

datalist of objects

pageinteger or null

limitinteger or null

linksobject

total_number_of_pagesinteger or nullDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors