Activity data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
candidate_id | string | No | |
application_id | string | No | |
job_id | string | No | |
interview_id | string | No | |
document_ids | string[] | No | IDs for AtsDocument.get |
title | string | No | |
description | string | No | |
is_private | boolean | No | |
user_ids | string[] | No | id values of the recruiters associated with the activity. |
type | enum | No | Values: NOTE, TASK, EMAIL |
from | object | No | |
from.name | string | No | |
from.email | string | No | |
from.type | enum | No | Values: WORK, HOME, OTHER |
to | AtsEmail[] | No | |
to[].name | string | No | |
to[].email | string | Yes | |
to[].type | enum | No | Values: WORK, HOME, OTHER |
cc | AtsEmail[] | No | |
cc[].name | string | No | |
cc[].email | string | Yes | |
cc[].type | enum | No | Values: WORK, HOME, OTHER |
bcc | AtsEmail[] | No | |
bcc[].name | string | No | |
bcc[].email | string | Yes | |
bcc[].type | enum | No | Values: WORK, HOME, OTHER |
sub_type | string | No | |
company_id | string | No | (reference to AtsCompany) |
metadata | AtsMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | Actual textual value of the slug |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know