Headers
-
Content-Type string
-
Accept string
-
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].
-
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).
GET
/api/v2/contact-details
curl \
--request GET https://api.plannrcrm.com/api/v2/contact-details \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Personal number",
"type": "email",
"uuid": "e7d40929-fac4-4f12-97e0-4e2ac9e20e2f",
"value": "+443330903630",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "6ef993ea-a5e8-4d14-92cf-cd9e771aed7e",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-02-20T10:13:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-02-20T10:13:06+00:00",
"updated_at": "2025-02-20T10:13:06+00:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
}
]
}