Query Individuals
POST {{baseUrl}}/api/ContactIndividual/Query?skip=<integer>&take=<integer>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. Max is 1000. |
Request Body
{"groups"=>[{"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}, {"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}], "sortBy"=>"<string>", "descending"=>"<boolean>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"list":[{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","prefix":"\u003cstring\u003e","firstName":"\u003cstring\u003e","middleName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","suffix":"\u003cstring\u003e","gender":"\u003cstring\u003e","isPrimary":"\u003cboolean\u003e","canBePrimary":"\u003cboolean\u003e","isSecondary":"\u003cboolean\u003e","canBeSecondary":"\u003cboolean\u003e","birthMonth":"\u003cinteger\u003e","birthDay":"\u003cinteger\u003e","birthYear":"\u003cinteger\u003e","birthDate":"\u003cstring\u003e","approximateAge":"\u003cinteger\u003e","isDeceased":"\u003cboolean\u003e","passion":"\u003cstring\u003e","avatarUrl":"\u003cstring\u003e","contactMethods":[{"id":"\u003cinteger\u003e","type":"\u003cstring\u003e","value":"\u003cstring\u003e","isOptedIn":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","canBePrimary":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","type":"\u003cstring\u003e","value":"\u003cstring\u003e","isOptedIn":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","canBePrimary":"\u003cboolean\u003e"}],"createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}],"customCollections":[{"customCollectionId":"\u003cinteger\u003e","customCollectionName":"\u003cstring\u003e","collectionInstanceId":"\u003cinteger\u003e","fields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}]},{"customCollectionId":"\u003cinteger\u003e","customCollectionName":"\u003cstring\u003e","collectionInstanceId":"\u003cinteger\u003e","fields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}]}]},{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","prefix":"\u003cstring\u003e","firstName":"\u003cstring\u003e","middleName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","suffix":"\u003cstring\u003e","gender":"\u003cstring\u003e","isPrimary":"\u003cboolean\u003e","canBePrimary":"\u003cboolean\u003e","isSecondary":"\u003cboolean\u003e","canBeSecondary":"\u003cboolean\u003e","birthMonth":"\u003cinteger\u003e","birthDay":"\u003cinteger\u003e","birthYear":"\u003cinteger\u003e","birthDate":"\u003cstring\u003e","approximateAge":"\u003cinteger\u003e","isDeceased":"\u003cboolean\u003e","passion":"\u003cstring\u003e","avatarUrl":"\u003cstring\u003e","contactMethods":[{"id":"\u003cinteger\u003e","type":"\u003cstring\u003e","value":"\u003cstring\u003e","isOptedIn":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","canBePrimary":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","type":"\u003cstring\u003e","value":"\u003cstring\u003e","isOptedIn":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","canBePrimary":"\u003cboolean\u003e"}],"createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}],"customCollections":[{"customCollectionId":"\u003cinteger\u003e","customCollectionName":"\u003cstring\u003e","collectionInstanceId":"\u003cinteger\u003e","fields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}]},{"customCollectionId":"\u003cinteger\u003e","customCollectionName":"\u003cstring\u003e","collectionInstanceId":"\u003cinteger\u003e","fields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}]}]}],"total":"\u003cinteger\u003e"}