v1

latestOpenAPI 3.0.02026-08-04109109370.6 KB

Activities

Get activities

get/activities

Query parameters

qstring

String search

limitinteger

How many activities to return

filter[participant][]string[]

Which participant to get activities related to

filter[status][]string[]

Which activities to get based on status

filter[leadPriority][]'hot'

Whether to only return activities related to hot leads

filter[activityType]integer[]

Which types of activities to get

filter[flagged]boolean

Only return flagged activities

filter[isImportant]boolean

Only return activities marked as important

filter[dateMin]string

The earliest activity to return

filter[dateMax]string

The latest activity to return

Response

Activity

htmlUrlstring

The link to the entity within the app.

htmlUrlPathstring

The path to the entity within the app.

idstring

The API ID of this entity, formatted {integer}-{entityType}

agendastring

The list of things to accomplish in the activity

createdTimeinteger

endTimeinteger

deletedTimeinteger

hrefstring

The URL to fetch this contact.

isAllDayboolean

Whether the activity is an all-day event

isEditableboolean

Whether the activity can still be modified

isCancelledboolean

Whether the activity occurred as planned or not

isFlaggedboolean

Whether the activity is marked as important or not

isLoggedboolean

Whether the activity has occurred yet or not

isOverdueboolean

Whether the activity was supposed to be logged by now or not

loggedTimeinteger

modifiedTimeinteger

namestring

The name of the activity

startTimeinteger

isMediaLoggedboolean

transcriptionstring

The transcription on the activity

Example response

{
  "htmlUrl": "https://app.nutshell.com/lead/1006",
  "htmlUrlPath": "/lead/1006",
  "activities": [
    {
      "htmlUrl": "https://app.nutshell.com/lead/1006",
      "htmlUrlPath": "/lead/1006",
      "id": "3-contacts"
    }
  ],
  "id": "3-contacts",
  "agenda": "Sign a contract with Andy",
  "href": "https://app.nutshell.com/rest/contacts/3-contacts",
  "name": "Meeting with Andy",
  "transcription": "Speaker 1: Hello.\\n Speaker 2: Good morning!"
}