Skip to main content
All CollectionsWrk Action LibraryAffinity
Retrieve all persons from Affinity
Retrieve all persons from Affinity
Wrk Product avatar
Written by Wrk Product
Updated over a month ago

Retrieve all persons from Affinity.

Application

  • Affinity

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

Return all?

Whether to return all results or only up to a given limit

True/False

No

Limit

Max number of results to return

Number

No

Search term

A 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 name

Text (Short)

No

With interaction dates?

Whether interaction dates will be present on the returned resources

True/False

No

Outputs (what you get)

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Outcomes

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.

Requirements

  • N/A

Did this answer your question?