GET /persons/{id}/flow

Lists updates about a person.
If a company uses the Campaigns product, then this endpoint's response will also include updates for the marketing_status field.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The ID of the person

Query parameters

Name Type Required Description
limit Integer No

Items shown per page

all_changes String No

Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

items String No

A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).

start Integer No

Pagination start

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.