For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Activity object
          • GET/activities
          • POST/activities
          • GET/activities/{id}
          • GET/activities/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsActivities

The Activity object

The Activity Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "user": "string",
7  "remote_created_at": "2023-01-01T00:00:00Z",
8  "activity_type": "NOTE",
9  "subject": "string",
10  "body": "string",
11  "visibility": "ADMIN_ONLY",
12  "candidate": "string",
13  "remote_was_deleted": true,
14  "field_mappings": {},
15  "remote_data": [
16    {
17      "path": "string",
18      "data": {}
19    }
20  ]
21}
Was this page helpful?
Previous

Versioning

Next

/activities

Built with

The Activity object is used to represent an activity for a candidate performed by a user.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
userstring or nullOptionalformat: "uuid"
The user that performed the action.
remote_created_atdatetime or nullOptional
When the third party's activity was created.
activity_typeenum or nullOptional

The activity's type.

  • NOTE - NOTE
  • EMAIL - EMAIL
  • OTHER - OTHER
Allowed values:
subjectstring or nullOptional
The activity's subject.
bodystring or nullOptional
The activity's body.
visibilityenum or nullOptional

The activity's visibility.

  • ADMIN_ONLY - ADMIN_ONLY
  • PUBLIC - PUBLIC
  • PRIVATE - PRIVATE
Allowed values:
candidatestring or nullOptionalformat: "uuid"
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only