Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Activity

getEntityActivityFeed

Get activity feed for an entity

get/v1/entity/{slug}/{id}/activity

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

idstring uuid required

Entity id

Query parameters

anonymizeboolean

When true, anonymizes PII in the response: identifiers (names, emails, phone numbers, IBANs) are replaced with deterministic pseudonyms (stable within an org), addresses are generalized to postal code / city / country, and well-known free-text fields (e.g. note content) are redacted.

Useful for AI agents and data analysis use cases that must not access personal data.

Anonymization is forced (regardless of this parameter) when the access token was created with anonymize: true.

afterstring date-time

Get activities strictly after this timestamp. Cannot be used with 'before', 'start_date', 'end_date', or 'preset_range'.

beforestring date-time

Get activities strictly before this timestamp. Cannot be used with 'after', 'start_date', 'end_date', or 'preset_range'.

start_datestring date-time

The inclusive start timestamp for a date range filter. Requires 'end_date' to also be provided. Cannot be used with 'before', 'after', or 'preset_range'.

end_datestring date-time

The inclusive end timestamp for a date range filter. Requires 'start_date' to also be provided. Cannot be used with 'before', 'after', or 'preset_range'.

preset_range'today' | 'this_week' | 'last_week'
Example:last_week

Get activities within a predefined date range (e.g., 'today', 'last_week'). Cannot be used with 'before', 'after', 'start_date', or 'end_date'.

frominteger

Starting page number

sizeinteger

max number of results to return

typestring[]

Filter by activity type(s)

[
  "EntityUpdated",
  "EntityCreated"
]
include_relationsboolean

Include activities from related entities

exclude_activity_groupsstring
Example:workflow

Exclude all activity types that are part of an activity group from results

Response

Success

totalinteger

Example response

{
  "total": 1,
  "results": [
    {
      "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
      "title": "My custom activity",
      "message": "{{caller}} did something with {{entity payload.entity.id}}.",
      "payload": {
        "entity": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "schema": "contact"
        }
      },
      "caller": {
        "EpilotAuth": {
          "token": {
            "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
            "cognito:groups": [
              "Administrator"
            ],
            "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
            "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
            "custom:ivy_org_id": "739224",
            "cognito:username": "n.ahmad@epilot.cloud",
            "custom:ivy_user_id": "10006129",
            "cognito:roles": [
              "arn:aws:iam::912468240823:role/base-administrator-role"
            ],
            "aud": "6e0jbdnger7nmoktaaflarue1l",
            "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
            "token_use": "id",
            "auth_time": 1614333023,
            "exp": 1614336623,
            "iat": 1614333023,
            "email": "n.ahmad@epilot.cloud"
          }
        }
      },
      "operations_total": 1,
      "operations": [
        {
          "org": "123",
          "activity_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
          "params": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "slug": "contact"
          },
          "payload": {
            "_schema": "contact",
            "_org": "123",
            "status": "Inactive"
          },
          "diff": {
            "added": {
              "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "_org": "123",
              "_owners": [
                {
                  "org_id": "123",
                  "user_id": "123"
                }
              ],
              "_schema": "contact",
              "_tags": [
                "example",
                "mock"
              ],
              "_created_at": "2021-02-09T12:41:43.662Z",
              "_updated_at": "2021-02-09T12:41:43.662Z",
              "_acl": {
                "view": [
                  "org:456",
                  "org:789"
                ],
                "edit": [
                  "org:456"
                ],
                "delete": [
                  "org:456"
                ]
              },
              "_manifest": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "updated": {
              "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "_org": "123",
              "_owners": [
                {
                  "org_id": "123",
                  "user_id": "123"
                }
              ],
              "_schema": "contact",
              "_tags": [
                "example",
                "mock"
              ],
              "_created_at": "2021-02-09T12:41:43.662Z",
              "_updated_at": "2021-02-09T12:41:43.662Z",
              "_acl": {
                "view": [
                  "org:456",
                  "org:789"
                ],
                "edit": [
                  "org:456"
                ],
                "delete": [
                  "org:456"
                ]
              },
              "_manifest": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "deleted": {
              "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "_org": "123",
              "_owners": [
                {
                  "org_id": "123",
                  "user_id": "123"
                }
              ],
              "_schema": "contact",
              "_tags": [
                "example",
                "mock"
              ],
              "_created_at": "2021-02-09T12:41:43.662Z",
              "_updated_at": "2021-02-09T12:41:43.662Z",
              "_acl": {
                "view": [
                  "org:456",
                  "org:789"
                ],
                "edit": [
                  "org:456"
                ],
                "delete": [
                  "org:456"
                ]
              },
              "_manifest": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          }
        }
      ]
    }
  ]
}