Contact

Get contact list.

get/api/v1/contact/list

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

Requested page offset.

sizeinteger

Requested page size.

offsetDatestring date-time

Include cards from/since (as per requested sort order) its offset date type.

offsetDateEndstring date-time

Include cards to/until (as per requested sort order) its offset date type.

offsetDateType'CreatedDate' | 'ModifiedDate' | 'SystemModifiedDate'

Offset date type.

offsetModifiedstring date-time

Include contacts from/since (as per requested sort order) its modified date.

offsetCreatedstring date-time

Include contacts from/since (as per requested sort order) its created date.

offsetIdstring

Id of last recieved contact in the previous batch when using offsetModified or offsetCreated

offsetHistoryIdstring

Next page of resources when offsetModified set

searchQuerystring

Plain text search query to filter contact list by.

contactIdsstring[]

List of contact ids to filter contact list by.

excludeContactIdsstring[]

List of contact ids to exclude from list.

groupIdstring

get contact from group

tagFilterRelation'Or' | 'And' | 'OrNot' | 'AndNot'

Query relation for tag filters. Default is 'and'.

tagsstring[]

List of tags to filter contact list by.

excludeTagFilterRelation'Or' | 'And' | 'OrNot' | 'AndNot'

Query relation for excludeTag filters. Default is 'and'.

excludeTagsstring[]

List of exclude tags to filter contact list by.

showHiddenboolean

flag to filter hidden contacts

contactSortOrder'Weight' | 'ModifiedDate' | 'CreatedDate'

Order of contact sorting (default is by weight).

sortOrder'Descending' | 'Ascending'

Order of contacts by contact sort parameter (default is descending).

contactTypesContactType[]

List of contact types.

subContactTypesGroupType[]

List of group types, applicable only when getting group contacts.

subGroupTypesGroupSubType[]

List of group sub types, applicable only when getting group contacts.

userTypesUserType[]

User types filter

Headers

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Response

OK

sizeinteger required

Page size

offsetinteger required

Page offset

offsetHistoryIdstring

Offset history id

totalSizeinteger required

Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

Changes

No recorded changes to this operation across all 1 revision of this API.