List all the Contacts of an organization matching the search parameters

get

https://explore.cloud4wi.com/v2/customers/organizations/{cid}

Role: Organization Manager

Scope: organization_read, customer_read

Path Params

cid

string

required

organization cid

Query Params

sid

string

The sid can be used to retrieve a large number of results from a search request. Read the full docs to learn how to use the sid

size

string

Number of Contacts returned by the request. Allowed values between 1 and 10000. It is not possible to change this values during a scrolling.

hasEmail

boolean

Return Contacts with email

emailVerified

boolean

Return Contacts with an email verified

hasPhone

boolean

Return Contacts with phone number

phoneVerified

boolean

Return Contacts with an phone number verified

signupMethods

string

Return Contacts with the requested signup method

locationCids

string

Return Contacts registered on specific locations

segmentCids

string

Return Contacts belonging to specific segment or segments (comma separated)

createdStart

string

Return Contacts with creation date >= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

createdEnd

string

Return Contacts with creation date <= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

modifiedStart

string

Return Contacts with modified date >= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

modifiedEnd

string

Return Contacts with modified date <= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

mktgCommunications

boolean

Return Contacts with marketing communication opt-in with value true

ageVerification

boolean

Return Contacts with age verification set to true

customOptIn.*

boolean

Return Contacts with specific custom opt-ins set to true. Eg: customOptin.my_policy=true

sortBy

string

firstName, lastName, gender, birthDate, country, created, privacy, termsOfUse, mktgCommunications, ageVerification, phone, phoneVerified, email, emailVerified, provider, username, locked, locations, system, enabled, type, modified_absolute,created_absolute,totalVisits,visitedLocations

sortReverse

boolean

Reverse sort order. sortBy argument is required

string

Search by email address

phoneNumber

string

Search by phone number

username

string

Search by username

extId

string

Search by external Id

extProp1

string

Search by external property 1

extProp2

string

Search by external property 2

Responses

default

errorResponse

200The array of the customers