Get all the emails the client is a participant of.
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
search string
Search for a message by subject, content or participant (name / email).
-
filter[incoming] boolean
Filter by incoming or outgoing messages.
-
filter[uuid] string
Filter by a comma separated list of message UUIDs.
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [firm, mailbox, participants, attachments].
-
sort string
Field to sort by. Valid fields are [created_at, updated_at, message_created_at]. Negative sign to denote DESC. Defaults to '-message_created_at'.
GET /api/v1/client/{client_uuid}/emails
curl \
-X GET https://api.plannrcrm.com/api/v1/client/client_uuid/emails \
-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": [
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "a1b49c57-8f3c-4f2a-80a6-6181234f594a",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"brand_colours": {
"sidebar_text": "#ffffff",
"sidebar_hover": "#0A0A42",
"email_sub_text": "#ffffff",
"sidebar_accent": "#36367E",
"sidebar_active": "#53DBB8",
"email_background": "#0E0E56",
"email_button_text": "#ffffff",
"sidebar_background": "#0E0E56",
"sidebar_title_primary": "#FFC634",
"email_button_background": "#36367E",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"email_logo_background_panel": "#36367E",
"sidebar_title_secondary_hover": "#ffffff"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!"
},
"html": "<p>Message body here in HTML</p>",
"text": "Message body here in plain text",
"uuid": "505ff448-31fe-4556-9c3c-6e5ebbfa8a2b",
"mailbox": {
"name": "Test Mailbox",
"type": "imap",
"uuid": "7446f507-79e0-42b8-867f-f9a46a6aea0e",
"email": "test@example.org",
"state": "connected",
"enabled": true,
"created_at": "2024-10-16T11:10:14+01:00",
"created_by": {
"firm": {
"example": "App\\Http\\Resources\\FirmResource",
"collection": false,
"description": "Firm"
},
"name": {
"example": "Gareth Thompson",
"collection": false,
"description": "Name"
},
"role": {
"example": "client",
"collection": false,
"description": "Account role"
},
"tags": {
"example": "App\\Http\\Resources\\TagResource",
"collection": true,
"description": "Tags"
},
"type": {
"example": "client",
"collection": false,
"description": "Account type"
},
"uuid": {
"example": "f4a27c71-8b08-4505-8d43-66d55c108a7c",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "Email"
},
"groups": {
"example": "App\\Http\\Resources\\GroupResource",
"collection": true,
"description": "Groups"
},
"owners": {
"example": "App\\Http\\Resources\\AccountResource",
"collection": true,
"description": "Accounts that own this account"
},
"last_name": {
"example": "Thompson",
"collection": false,
"description": "Last name"
},
"created_at": {
"example": "2024-10-16T11:10:14+01:00",
"collection": false,
"description": "The timestamp of when the resource was created."
},
"first_name": {
"example": "Gareth",
"collection": false,
"description": "First name"
},
"updated_at": {
"example": "2024-10-16T11:10:14+01:00",
"collection": false,
"description": "The timestamp of when the resource was updated."
},
"with_login": {
"example": true,
"collection": false,
"description": "Denotes whether the account has a login to Plannr"
},
"custom_fields": {
"example": "App\\Http\\Resources\\CustomFieldValueResource",
"collection": true,
"description": "Any custom fields on the model."
},
"introduced_by": {
"example": "App\\Http\\Resources\\AccountResource",
"collection": false,
"description": "Introduced by"
},
"primary_email": {
"example": "App\\Http\\Resources\\ContactDetailResource",
"collection": false,
"description": "Primary email"
},
"can_be_deleted": {
"example": "false",
"collection": false,
"description": "Denotes if the account can be deleted"
},
"assigned_adviser": {
"example": "App\\Http\\Resources\\AccountResource",
"collection": false,
"description": "Assigned adviser"
},
"next_review_date": {
"example": "2024-10-16T11:10:14+01:00",
"collection": false,
"description": "Next review date"
},
"has_joint_account": {
"example": true,
"collection": false,
"description": "Denotes whether this account belongs to a joint account too"
},
"current_time_entry": {
"example": "App\\Http\\Resources\\TimeEntryResource",
"collection": false,
"description": "Current time entry"
},
"first_contact_date": {
"example": "2024-10-16T11:10:14+01:00",
"collection": false,
"description": "First contact date"
},
"external_references": {
"example": "App\\Http\\Resources\\ExternalReferenceResource",
"collection": true,
"description": "The external references that have been added to the client."
},
"assigned_paraplanner": {
"example": "App\\Http\\Resources\\AccountResource",
"collection": false,
"description": "Assigned paraplanner"
},
"previous_review_date": {
"example": "2024-10-16T11:10:14+01:00",
"collection": false,
"description": "Previous review date"
},
"primary_phone_number": {
"example": "App\\Http\\Resources\\ContactDetailResource",
"collection": false,
"description": "Primary phone number"
},
"assigned_administrator": {
"example": "App\\Http\\Resources\\AccountResource",
"collection": false,
"description": "Assigned administrator"
},
"anniversary_review_date": {
"example": "2024-10-16T11:10:14+01:00",
"collection": false,
"description": "Anniversary review date"
}
},
"updated_at": "2024-10-16T11:10:14+01:00",
"message_count": 1
},
"subject": "Hello World",
"incoming": true,
"ancestors": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"html": "<p>Message body here in HTML</p>",
"text": "Message body here in plain text",
"uuid": "0d88e8c0-e1ac-44f0-bf46-a88cc05dda77",
"mailbox": "App\\Http\\Resources\\MailboxResource",
"subject": "Hello World",
"incoming": true,
"ancestors": "App\\Http\\Resources\\MailboxMessageResource",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"attachments": "App\\Http\\Resources\\MailboxMessageAttachmentResource",
"descendants": "App\\Http\\Resources\\MailboxMessageResource",
"participants": "App\\Http\\Resources\\MailboxMessageParticipantResource",
"thread_count": "App\\Http\\Resources\\MailboxMessageResource",
"message_created_at": "2024-10-16T11:10:14+01:00"
}
],
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"attachments": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "example.pdf",
"size": 123456,
"type": "application/pdf",
"uuid": "fe12de83-93ac-4787-91d5-b29e2a897f22",
"status": "uploaded",
"extension": "pdf",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"download_url": "https://example.com/download/attachment"
}
],
"descendants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"html": "<p>Message body here in HTML</p>",
"text": "Message body here in plain text",
"uuid": "fb56758a-6200-4f34-beaf-b8b821b7d5b2",
"mailbox": "App\\Http\\Resources\\MailboxResource",
"subject": "Hello World",
"incoming": true,
"ancestors": "App\\Http\\Resources\\MailboxMessageResource",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"attachments": "App\\Http\\Resources\\MailboxMessageAttachmentResource",
"descendants": "App\\Http\\Resources\\MailboxMessageResource",
"participants": "App\\Http\\Resources\\MailboxMessageParticipantResource",
"thread_count": "App\\Http\\Resources\\MailboxMessageResource",
"message_created_at": "2024-10-16T11:10:14+01:00"
}
],
"participants": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "John Doe",
"type": "cc",
"uuid": "57dab329-b3aa-47ec-85be-a604dc3b7dae",
"email": "john.doe@example.com",
"mailbox": "App\\Http\\Resources\\MailboxResource",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"mailbox_message": "App\\Http\\Resources\\MailboxMessageResource"
}
],
"thread_count": {
"firm": "App\\Http\\Resources\\FirmResource",
"html": "<p>Message body here in HTML</p>",
"text": "Message body here in plain text",
"uuid": "37f2189c-78c9-4623-ae87-e5943c187ab5",
"mailbox": "App\\Http\\Resources\\MailboxResource",
"subject": "Hello World",
"incoming": true,
"ancestors": "App\\Http\\Resources\\MailboxMessageResource",
"created_at": "2024-10-16T11:10:14+01:00",
"updated_at": "2024-10-16T11:10:14+01:00",
"attachments": "App\\Http\\Resources\\MailboxMessageAttachmentResource",
"descendants": "App\\Http\\Resources\\MailboxMessageResource",
"participants": "App\\Http\\Resources\\MailboxMessageParticipantResource",
"thread_count": "App\\Http\\Resources\\MailboxMessageResource",
"message_created_at": "2024-10-16T11:10:14+01:00"
},
"message_created_at": "2024-10-16T11:10:14+01:00"
}
]
}