FOfolk
Interactions

Get a past or upcoming interaction

Changed on

Retrieves a single interaction. Full email or calendar body is included when privacy rules allow it.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

get/v1/interactions/{interactionId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/interactions/{interactionId}
  • Auth
    HTTP bearer

Path parameters

string required
OR
string required

The ID of the interaction to retrieve.

Query parameters

entity.idstring required

The person, company, or object linked to the interaction.

Response

The retrieved interaction.

deprecationsstring[]

Example response

{
  "data": {
    "id": "b049db09-c03d-4f32-96d6-d314760add5d@gmail.com",
    "interactionType": "email",
    "entity": {
      "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
      "entityType": "person",
      "fullName": "John Doe"
    },
    "dateTime": "2025-07-17T09:00:00.000Z",
    "url": "https://mail.google.com/mail/u/0/#inbox/abc123",
    "privacyLevel": "sharedFull",
    "from": {
      "type": "email",
      "value": "jane@example.com",
      "name": "Jane Doe"
    },
    "to": [
      {
        "type": "email",
        "value": "john@example.com",
        "name": "John Doe"
      }
    ],
    "content": {
      "subject": "Project kickoff",
      "snippet": "Looking forward to discussing the roadmap."
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes