Skip to main content

Retrieve all persons from Affinity

Retrieve all persons from Affinity.

Application

  • Affinity

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected AccountThe connected account to use for the requestConnected AccountYes
Return all?Whether to return all results or only up to a given limitTrue/FalseNo
LimitMax number of results to returnNumberNo
Search termA string used to search all the persons in your team’s address book. This could be an email address, a first name or a last nameText (Short)No
With interaction dates?Whether interaction dates will be present on the returned resourcesTrue/FalseNo

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A