Skip to main content
GET
List activity

Authorizations

Authorization
string
header
required

A Parley API key.

Query Parameters

kinds
enum<string>[]

Only these kinds of activity. created, deleted, field_updated, note_created, note_deleted, files_added, and files_deleted happen to the record in entity; a rename is a field_updated of name. linked is a contact joining an account, or an account or contact linked to a project, which is relatedEntity. uscis_update is a USCIS case status update on a project. email is a synced email and meeting a synced calendar event, each on one of the contacts on it.

Minimum array length: 1
Available options:
created,
deleted,
field_updated,
linked,
note_created,
note_deleted,
files_added,
files_deleted,
uscis_update,
email,
meeting
entityTypes
enum<string>[]

Only activity on these kinds of records (entity.type): project, account, or contact. Emails and meetings are on contacts.

Minimum array length: 1

The kind of record: project, account, or contact.

Available options:
project,
account,
contact
userId
string

Only activity involving the user with this ID: what they did, emails they sent or that reached their connected mailbox, and meetings on their connected calendar.

Minimum string length: 1
since
string

Only activity at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

before
string

Only activity before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

Case-insensitive text in the activity itself: field names and values, USCIS statuses, descriptions, and receipt numbers, the subjects and bodies of emails you can read, and meeting titles and locations. Record names and note titles aren't searched.

Minimum string length: 1
field
string

Only field_updated activity for this field: its ID, or text in its name, case-insensitive.

Minimum string length: 1
emailDirection
enum<string>

Only emails in this direction.

Available options:
inbound,
outbound
cursor
string

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

Minimum string length: 1
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 250

Response

OK

data
object[]
required

One thing that happened, told apart by kind: each kind carries its own details, such as field for field_updated and email for email.

nextCursor
string | null
required

Cursor for the next page, or null on the last page.