Zoey REST API reference ยท Interactive version: apidocs.zoey.com

Activities

Get All

GET https://container-url.zoeysite.com/api/rest/crm/activity/list

Query parameters:

NameExampleNotes
limit1Limit the response.
page2Paginate the response.
sort[id]DESCSort by ID descending
filters[company_id][eq]1Account Filter
filters[created_at][gt]2025-07-30Created At Filter
advFilters{"AND": [{"updated_at":{"gt":"2021-07-30"}}]}Advanced Filters as json
options[order_pinned_first]1Option to order pinned activities first

Get

GET https://container-url.zoeysite.com/api/rest/crm/activity

Query parameters:

NameExampleNotes
id1ID of activity to fetch info. ( Required )

Count

GET https://container-url.zoeysite.com/api/rest/crm/activity/count

Count activities

Query parameters:

NameExampleNotes
filters[created_at][gt]2025-07-30Created At filter

Create

POST https://container-url.zoeysite.com/api/rest/crm/activity

Param Type Description
data ActivityData Activity create data

ActivityData

Data to update on an activity

Param Type Description
type string Activity type code. Cannot be changed after creation.

call
meeting
note
links LinksData Activity links object data described below. Must have at least one account link.
pinned_at string Pinned date in format YYYY-MM-DD HH:MM:SS
note string Note content
start_date
Activity Type: Call, Meeting
string Start date in format YYYY-MM-DD
start_time
Activity Type: Call, Meeting
string Start time in format HH:MM
durationActivity Type: Call, Meeting string Duration code

min_15 15 MIN
min_30 30 MIN
min_45 45 MIN
min_60 1 HR
min_90 1 HR 30 MIN
min_120 2 HR
min_120_plus 2HR+
call_type_id
Activity Type: Call
int Call type ID
outcome_id
Activity Type: Call
int Outcome ID
contacts
Activity Type: Call
array List of customer IDs. This will replace all contacts data.
meeting_type_id
Activity Type: Meeting
int Meeting type ID
attendees
Activity Type: Meeting
array List of customer IDs. This will replace all attendees data.

LinksData

links Type Description
company array Account IDs to link
location array Location IDs to link
customer array Contact IDs to link
call array Call Activity IDs to link
meeting array Meeting Activity IDs to link
note array Note Activity IDs to link

Example request body:

{
    "data": {
        "type": "note",
        "note": "note content",
        "links": {
            "company": [
                "1"
            ],
            "customer": [
                "2"
            ]
        }
    }
}

Update

PUT https://container-url.zoeysite.com/api/rest/crm/activity

Param Type Description
id string ID for the activity being updated.
data ActivityData Activity update data

Example request body:

{
    "id": 1,
    "data": {
        "note": "note content update"
    }
}

Delete

DELETE https://container-url.zoeysite.com/api/rest/crm/activity

Example request body:

{
    "id": 1
}