Get all contact details

GET /api/v2/contact-details

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[account_uuids] string

Filter by a comma separated list of UUIDs.
filter[circle_uuids] string

Filter by a comma separated list of UUIDs.
include string

Comma separated list of relationships to include in the response. Valid relationships are [accounts, primary_accounts].
sort string

Field to sort by. Valid fields are [created_at, updated_at, name, value]. Negative sign to denote DESC. Defaults to 'created_at'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  value string
  
  phone_number_meta object
  
  Hide phone_number_meta attributes Show phone_number_meta attributes object
  
  country string
  
  formatted string
  
  accounts object
  
  Hide accounts attributes Show accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
  
  primary_accounts object
  
  Hide primary_accounts attributes Show primary_accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string

GET /api/v2/contact-details

curl \
 --request GET 'https://api.plannrcrm.com/api/v2/contact-details' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Personal number",
      "type": "email",
      "uuid": "96ce11d7-d06c-4892-900a-63090c2a9254",
      "value": "+443330903630",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "c0ebec61-2098-4b16-8e74-bf668c6816f8",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-07-17T16:23:26+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-07-17T16:23:26+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-07-17T16:23:26+01:00",
      "updated_at": "2025-07-17T16:23:26+01:00",
      "primary_accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "148a390a-03d9-48f9-98c5-d71cf7497eb5",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-07-17T16:23:26+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-07-17T16:23:26+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    }
  ]
}