API ReferenceActivities

Read Activity

Info for a specific activity

Path parameters

activityIdstringRequired

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

Expected response to a valid request
assignedUserIdstring or nullformat: "uuid"
createdAtdatetime or null
customerStatusstring or null
deletedAtdatetime or null
householdobject or null
householdIdstring or nullformat: "uuid"
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
notesstring or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
prospectobject or null
prospectIdstring or nullformat: "uuid"
readableIdstring or null
startTimedatetime or null
typeenum or null
updatedAtdatetime or null
userobject or null