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.

  • filter[type] string

    Comma separated list of types to filter by. Valid filters are [email, phone_number].

  • filter[value] string

    Comma separated list of partial values to filter by.

  • 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": "fddfc40c-7876-4156-bf78-28bd9eab9fe9",
      "value": "+443330903630",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "8e190ded-b840-41fe-8270-a19bec28217a",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-12-04T22:09:17+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-12-04T22:09:17+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-12-04T22:09:17+00:00",
      "updated_at": "2025-12-04T22:09:17+00:00",
      "primary_accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "4edcc104-e90d-4bbb-80a7-bfe6f629f381",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-12-04T22:09:17+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-12-04T22:09:17+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    }
  ]
}