Contact

Get workspace contact list.

get/api/v1/contact/workspace

Request

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

Query parameters

sizeinteger

Requested page size.

searchQuerystring

Plain text search query to filter contact list by.

explicitContactIdstring

return contact on first position

excludeContactIdsstring[]

List of contact ids to exclude from list.

workspaceIdstring

workspace id to get contacts from, if not provided, primary subscription will be used

includeMemberTypesSubscriptionMemberType[]

List of subscription member types to include users from.

Headers

Loop-Workspace-Idstring

Workspace id header, used when workspaceId is not provided.

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.