Skip to main content

Retrieve a list of profiles

Retrieve a list of profiles

Authorizations:Token, JWT
Query Parameters
pageintegerDefault: 1The collection page number
itemsPerPageinteger[0 .. 100]Default: 30The number of items per page
paginationbooleanEnable or disable pagination
filter.first_login_date.rangeobject (Range filter for "first_login_date" field)Range filter for "first_login_date" field
beginstring or null
endstring or null
filter.create_date.rangeobject (Range filter for "create_date" field)Range filter for "create_date" field
beginstring or null
endstring or null
filter.loginstringFilter for "login" field
filter.searchFakeFieldstringFilter for "searchFakeField" field

Responses

200Profile collection
Response schema:
Profile collection
Array
idinteger
emailstring
membershipIdinteger>= 0
addressesArray of objects
Array
is_billingboolean
is_shippingboolean
is_workboolean
typestringDefault: "R"Enum: "R""C"
titlestring
firstnamestring
lastnamestring
phonestring
address1string
address2string
address3string
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger>= 0
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
idinteger>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null