Get all account contact details

GET /api/v1/account/{account_uuid}/contact-detail

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [account].

  • filter[uuid] 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].

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, type, 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 attributes Show response attributes object
    • uuid string

      UUID of the contact detail

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • type string

      Contact detail type

    • primary boolean

      If primary contact of the type

    • name string

      Contact detail description

    • value string

      Contact detail value

    • phone_number_meta object

      If the type is a phone number, this additional field will be displayed giving you information about the phone number.

    • account object

      Account owner
GET /api/v1/account/{account_uuid}/contact-detail 
curl \
 -X GET https://api.plannrcrm.com/api/v1/account/account_uuid/contact-detail \
 -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) 
{
  "name": "Work number",
  "type": "phone_number",
  "uuid": "71557310-a72f-49eb-85ca-8d6dc2065a36",
  "value": "+443330903630",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "e384c832-7fd4-48df-959c-1049e33d8c48",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:13+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:13+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:13+01:00"
  },
  "primary": true,
  "created_at": "2024-10-16T11:10:13+01:00",
  "updated_at": "2024-10-16T11:10:13+01:00",
  "phone_number_meta": {
    "country": "GB",
    "formatted": "0333 090 3630"
  }
}