Get all contact details

GET /api/v2/contact-details

Headers

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].
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]
  
  Additional properties are allowed.

GET /api/v2/contact-details

curl \
 -X GET https://api.plannrcrm.com/api/v2/contact-details \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Personal number",
      "type": "email",
      "uuid": "9e08d994-2be3-4eb3-9e24-a45eaef5dfdc",
      "value": "+443330903630",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "5b6f31fc-3326-418e-807e-215802fda9f0",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-01-17T11:18:33+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:33+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-01-17T11:18:33+00:00",
      "updated_at": "2025-01-17T11:18:33+00:00",
      "phone_number_meta": {
        "country": "GB",
        "formatted": "0333 090 3630"
      }
    }
  ]
}