Display a list of mailboxes for the current firm.
Normal employees can only see their own mailboxes. Owners and Senior Employees can see all mailboxes.
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
GET
/api/v1/mailboxes
curl \
--request GET 'https://api.plannrcrm.com/api/v1/mailboxes' \
--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": "Test Mailbox",
"type": "imap",
"uuid": "7183f2a6-a109-4cd7-828c-5f25e0d20ab9",
"email": "test@example.org",
"state": "connected",
"enabled": true,
"created_at": "2025-04-02T13:27:54+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": "238d0bae-7644-497e-a9d1-9f16f9f751e7",
"collection": false,
"description": "The UUID of the resource."
},
"email": {
"example": "gareth@codepotato.co.uk",
"collection": false,
"description": "(Deprecated - Please use primary_email instead). The email of the account."
},
"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": "2025-04-02T13:27:54+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": "2025-04-02T13:27:54+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"
},
"inactive_at": {
"example": "2025-04-02",
"collection": false,
"description": "Inactive from date"
},
"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": "2025-04-02T13:27:54+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": "2025-04-02T13:27:54+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"
},
"joint_account_circle": {
"example": "App\\Http\\Resources\\CircleResource",
"collection": false,
"description": "This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles."
},
"ownership_percentage": {
"example": 100,
"collection": false,
"description": "Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)"
},
"previous_review_date": {
"example": "2025-04-02T13:27:54+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": "2025-04-02T13:27:54+01:00",
"collection": false,
"description": "Anniversary review date"
}
},
"updated_at": "2025-04-02T13:27:54+01:00",
"message_count": 1
}
]
}