FOfolk
Interactions

List interactions

Changed on

Retrieves paginated past or upcoming interactions linked to a person, company, or object, optionally filtered by imported interaction type and workspace member.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

get/v1/interactions

Request

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

Query parameters

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

entity.idstring required

The person, company, or object linked to interactions.

timeframe'past' | 'upcoming' required

Whether to list past interactions (most recent first) or upcoming interactions.

''
OR
'email' | 'calendar' | 'whatsapp' | 'call'
OR
string[]

The imported interaction types to include. Repeat the parameter to pass several types. Omit to return every imported type. Pass an empty value (importedTypes=) to return only logged interactions. Logged interactions are always returned.

string
OR
string[]

Only return interactions of these workspace members. Repeat the parameter to pass several users.

Response

A paginated list of interactions with optional pagination link.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "lit_b049db09-c03d-4f32-96d6-d314760add5d",
        "interactionType": "logged",
        "from": {
          "type": "user",
          "value": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
          "name": "John Doe"
        },
        "to": {
          "type": "person",
          "value": "per_55175e81-9a52-4ac3-930e-82792c23499b",
          "name": "John Doe"
        },
        "entity": {
          "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
          "entityType": "person",
          "fullName": "John Doe"
        },
        "dateTime": "2025-07-17T09:00:00.000Z",
        "privacyLevel": "sharedFull",
        "title": "Coffee with John Doe",
        "content": "Had a coffee with John Doe\nDiscussed the new project.",
        "type": "coffee",
        "activityType": "coffee"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/interactions?timeframe=past&entity.id=per_55175e81-9a52-4ac3-930e-82792c23499b&cursor=eyJmb28iOiJiYXIifQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes