Appearance

List Activities ​

Endpoint ​

http
GET /unified/ats/activities
Integrations supported
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • Workable

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
actor
object

The actor to filter the activities by.

Required in
  • Fountain
id
string
REQUIRED · 

The ID of the actor to filter the activities by.

type
string

Type of the actor

All possible enum values:
  • candidate
  • user
created_at
string · date-time

The date and time of the activity's creation

Supported in
  • Fountain
activity_type
string

The type of the activity to filter the activities by.

All possible enum values:
  • email
  • note
Supported in
  • Fountain
organization_id
string

The ID of the organization to filter the activities by.

Supported in
  • Breezy
job_id
string

The ID of the job to filter the activities by.

Required in
  • Breezy
candidate_id
string

The ID of the candidate to filter the activities by.

Required in
  • Ashby
  • Breezy
  • Greenhouse
candidate
object

The activity's candidate

Supported in
  • Workable
id
string

Unique identifier of the candidate

Response Body ​

result
object[]

List of Activities

id
string
REQUIRED · 

The activity's unique identifier

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • Workable
candidate
object

The activity's candidate

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • Workable
id
string

Unique identifier of the candidate

actor
object

The activity's actor

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • Workable
id
string

Unique identifier of the actor

type
string

Type of the actor

All possible enum values:
  • user
  • candidate
activity_type
string

The activity's type

All possible enum values:
  • note
  • email
Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • Workable
from
object[]

From email addresses if the activity_type is email

Supported in
  • Greenhouse
email
string

Email of the sender

name
string

Name of the sender

to
object[]
Supported in
  • Greenhouse
email
string

Email of the recipient

name
string

Name of the recipient

cc
object[]
Supported in
  • Greenhouse
email
string

Email of the recipient

name
string

Name of the recipient

subject
string

The activity's subject

Supported in
  • Breezy
  • Greenhouse
body
string

The activity's body

Supported in
  • Ashby
  • Breezy
  • Greenhouse
  • Workable
visibility
string

The activity's visibility

All possible enum values:
  • private
  • public
  • admin_only
Supported in
  • Greenhouse
updated_at
string · date-time

The date and time of the activity's last update

created_at
string · date-time

The date and time of the activity's creation

Supported in
  • Ashby
  • Fountain
  • Greenhouse
  • Workable
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.