BVbvnk
Contacts

List contacts

Changed on

:::warning Beta Contacts v3 is in beta and may change as we continue to improve it. Please review the documentation and endpoints carefully, test everything in the sandbox, and reach out to the Solutions team if you need help. :::

Returns a paginated list of contacts for your account. Use query parameters to filter by search term, entity type, or relationship type.

get/platform/v3/contacts

Request

Query parameters

pageNumberinteger

Page number for pagination. Starts from 0.

pageSizeinteger

Number of items to return per page.

qstring

Search query string. Supports structured filters: searchTerm:<value> for name search, type:<INDIVIDUAL|COMPANY> for entity type, and relationshipType:<THIRD_PARTY|SELF_OWNED> for relationship filter. Combine multiple filters separated by spaces.

Response

Contacts retrieved

hasNextboolean

Indicates whether more pages are available.

Example response

{
  "content": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "description": "Primary payment partner",
      "category": "DEFAULT",
      "entity": {
        "type": "INDIVIDUAL",
        "relationshipType": "THIRD_PARTY",
        "firstName": "Jane",
        "lastName": "Doe",
        "dateOfBirth": "1990-06-15",
        "address": {
          "addressLine1": "10 Downing Street",
          "city": "London",
          "region": "Greater London",
          "stateCode": "NY",
          "postalCode": "SW1A 2AA",
          "country": "GB"
        }
      },
      "createdAt": "2026-06-10T10:30:00Z",
      "updatedAt": "2026-06-10T10:30:00Z"
    }
  ]
}

Changes