List Customers

Retrieves a list of customers from Retently.

GET

Query

Arguments

string

Find a customer by the email address;

number

The current page number. Default 1;

number

The items limit. Default 20. Maximum 1,000;

string

The sort option. Use '-' for DESC. Default '-createdDate';

string

ISO format or UNIX timestamp;

string

ISO format or UNIX timestamp;

array of string

Filter by customer properties. See Attributes Filtering section below;

string

Logic for multiple attribute filters. Values: 'all' (AND, default), 'any' (OR);

stringrequired

Attribute field name

stringrequired

Filter operator

stringrequired

Attribute match value

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

curl --request GET \ --url "https://connect.mindcloud.co/v1/universal/retently/0.0.6/actions/list-customers" \ --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \ --get \ --data-urlencode 'connectionId=$CONNECTION_ID' \ --data-urlencode 'page=1' \ --data-urlencode 'limit=20' \ --data-urlencode 'match=all' \ --data-urlencode 'attributes[].name=' \ --data-urlencode 'attributes[].op=' \ --data-urlencode 'attributes[].value='

{ "success": true, "data": [ { "companyId": "string", "companyName": "string", "createdDate": "string", "email": "[email protected]", "firstName": "Ava", "id": "string", "integrationsLists": [ "string" ], "isAnonymous": true, "isAtRisk": true, "isEmailDeliverable": true, "isInQueue": true, "isInQueueSetAt": "string", "jobTitle": "string", "lastName": "Chen", "lastSurveySent": {}, "location": {}, "phoneNumber": "string", "properties": [ {} ], "source": "string", "surveySubscriptionStatus": {}, "syncId": "string", "tags": [ "string" ], "updatedDate": "string" } ], "meta": {} }

Query

Every app you connect,one REST pattern