Skip to main content

Emails

NewBeta

EmailSummary objects list the emails associated with a specific record (a guest card or an occupancy). Each summary contains display metadata only — fetch /v1/email?emailId=<id> to retrieve the full Email object with body and attachments.

The EmailSummary Object​

Attributes

appfolioIdstring
AppFolio ID of the email.
Example:
"123456789"
statusstring
Delivery status of the email (e.g. Delivered).
Example:
"Delivered"
sentAtstring
Date and time the email was sent.
Example:
"2026-04-12T23:21:00.000Z"
tostring
Recipient of the email as displayed in AppFolio.
Example:
"Tenant Smith"
fromstring
Sender of the email as displayed in AppFolio.
Example:
"Management"
subjectstring
Subject line of the email (plain text).
Example:
"Gate code has changed!!"
hasAttachmentboolean
True when the email has one or more attachments.
Example:
true
The EmailSummary Object
{
  "appfolioId": "123456789",
  "status": "Delivered",
  "sentAt": "2026-04-12T23:21:00.000Z",
  "to": "Tenant Smith",
  "from": "Management",
  "subject": "Gate code has changed!!",
  "hasAttachment": true
}

Get All Emails​

GET /v1/emails?guestCardId=<guestCardId> or GET /v1/emails?occupancyId=<occupancyId>

Follows: Authentication • Caching • Polling • List Response Format • Scheduled Job

The emails endpoint returns a list of emails associated with a given guest card or occupancy in your AppFolio® account. Provide exactly one of guestCardId or occupancyId. This endpoint should respond immediately with your most recently cached data.

Parameters​

guestCardIdstring
AppFolio ID of the guest card to get emails for.
occupancyIdstring
AppFolio ID of the occupancy to get emails for.
 

Returns​

The standard List Response Format with a data property containing an array of EmailSummary objects. To retrieve the full body, headers, and attachments for a summary, call /v1/email?emailId=<appfolioId>.

GET /v1/emails?guestCardId=1845
curl -X GET 'https://api.skywalkapi.com/v1/emails?guestCardId=1845' \ 
  -H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
  "meta": {
    "status": "ok",
    "path": "/v1/emails",
    "query": {
      "guestCardId": "1845"
    },
    "count": 1,
    "lastUpdated": 1610992228
  },
  "links": {
    "next": "/v1/emails?cursor=abcdefg"
  },
  "data": [
    {
      "appfolioId": "123456789",
      "status": "Delivered",
      "sentAt": "2026-04-12T23:21:00.000Z",
      "to": "Tenant Smith",
      "from": "Management",
      "subject": "Gate code has changed!!",
      "hasAttachment": true
    }
  ]
}