--- title: "Get Card search list." method: POST path: "/api/v1/card/list" tags: ["Card"] --- # Get Card search list. `POST /api/v1/card/list` ## Request - Base URL: `https://api.intheloop.io` - URL: `https://api.intheloop.io/api/v1/card/list` - Auth: API key in header `Authorization` ## Query parameters - `htmlFormat` string ## Headers - `Authorization` string - `X-Impersonate-User` string ## Request body - SearchQueryConversation: Search query for cards - `queryText` string: Query text - `size` integer, required: Size of results - `sortOrder` 'Descending' | 'Ascending', required: Sort direction enum - `sortType` 'ModifiedDate' | 'CreatedDate' | 'ViewDate', required: Sort Type enum - `historyId` string: Histroy id - `historyStartDate` string, date-time: Histroy start date if HistoryId is not yet define - `historyEndDate` string, date-time: Histroy start end if HistoryId is not yet define - `responseFormat` string: Response format (small) - `$type` string, required - `commonConversationConditions` SearchQueryConversationConditions: Search query card condition - `queryText` string: query text - `tagsConditions` SearchQueryCommonTagsConditions: Search common tags query - `tagFilterRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `tagFilter` string[]: tag filter - `sharedTagFilterRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `sharedTagFilter` string[]: shared tag filter - `cardTypes` CardType[]: List of card types to filter card list by. - `conversationConditionsRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `conversationConditions` SearchQueryConversationConditionsWithConditions[]: ConversationConditon with condition - `conversationConditions` SearchQueryConversationConditions[]: card condition - `queryText` string: query text - `tagsConditions` SearchQueryCommonTagsConditions: Search common tags query - `tagFilterRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `tagFilter` string[]: tag filter - `sharedTagFilterRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `sharedTagFilter` string[]: shared tag filter - `cardTypes` CardType[]: List of card types to filter card list by. - `conversationConditionsRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `conversationConditionsRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `conversationConditionsRelation` 'Or' | 'And' | 'OrNot' | 'AndNot', required: Query relation enum. - `showInView` ShowInViewObject: Show in view filter class - `view` 'LoopInbox' | 'PersonalInbox' | 'Channel', required: Possible View Types - `filter` 'Inbox' | 'Chats' | 'Drafts' | 'Archived' | 'Assigned' | 'Sent' | 'Starred' | 'Muted' | 'Deleted' | 'AllMessages' | 'Snoozed' | 'SnoozedDue' | 'Unread' | 'Spam' | 'Purge': Possible Filter Types - `channelId` string: Channel Id (groupId or contactId) - `folderId` string: Folder id - `conversationIds` string[]: Filter by converstaion ids - `hasUnreads` boolean: Does conversation contain unreads - `viewDateGreaterThan` string, date-time: View date must be greater than - `conversationDateFrom` string, date-time: Conversation date (precision is date without hour - search by date) must be greater than or equal - `conversationDateTo` string, date-time: Conversation date (precision is date without hour - search by date) must be less than or equal - `channelIds` string[]: Filter list of channels one must exists - `includeOldPersonalConversations` boolean, required: Get old personal cards - `includeConversationAttachmentSignedLink` boolean, required: Include conversation attachment signed links - `showOnlyAssigned` boolean, required: Show only assigned conversations - `showOnlyNotAssigned` boolean, required: Show only not assigned conversations - `showOnlyPurged` boolean, required: Show only purged conversation - `showOnlyNotPurged` boolean, required: Show only not purged conversations - `hasPreventPurgeTag` boolean: Does conversation has / has not prevent purge tag - `showOnlyChannelDeletedView` boolean, required: Show only channel deleted view - `showOnlyClosedConversion` boolean, required: Show only closed conversation - `showOnlyNotClosedConversion` boolean, required: Show only not closed conversation - `showOnlyConversionWithAttachment` boolean, required: Show only conversation with attachments - `showOnlyConversionWitNoAttachment` boolean, required: Show only conversation with no attachments ## Response `200` OK - ListOfResourcesOfCardBase: List of resources - `resources` CardBase[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `author` User: User contact resource. - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, 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 - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `userIdentificator` string: User's Identificator for EmailUser is email for phone is telephone, .... - `userType` 'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser', required: User types - `email` string: User's email address - `firstName` string: User's first name - `lastName` string: User's last name - `onlineStatus` string: Online status (possible values can be seen at enums/UserStatus) - `lastActivityAt` string, date-time: Date time of the user's last activity - `displayName` string: User's display name, set only for senders and should be displayed per comment, mostly nullable - `changableDisplayName` boolean: ChangableDisplayName indicates that user has changable name (example github notification user) - `availabilityStatus` AvailabilityUserStatus: Subscription availability status for user - `status` string: Status - `emoji` string: Availability Emoji - `clearAfter` string, date-time: Availability clear after in minutes - `enabledAssignments` boolean, required: Availability available for assignments - `outOfOffice` boolean, required: Availability out of office - `shareList` ListOfResourcesOfContactBase: List of resources - `resources` ContactBase[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - … - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, 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 - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `weight` number: Usage weight. - `created` string, date-time: Date time of contact creation - `modified` string, date-time: Date time of last time contact was modified - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, 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 - `tags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, 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 - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `sharedTags` ListOfTags: List of tags resource - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tags` ListOfResourcesOfTag: List of resources - `resources` Tag[]: List of resources - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, 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 - `parent` ResourceBase: Resource base - `id` string: Resource id - `name` string: Resource name or title - `revision` string: Resource revision - `clientId` string: Resource client id - `$type` string, required - `created` string, date-time: Time of card creation - `channelType` string: Channel Type - `loopinHandledBySystem` boolean: Information for integration. Do not loop this card - is allready loop in - `size` integer, required: Page size - `offset` integer, required: Page offset - `offsetHistoryId` string: Offset history id - `totalSize` integer, 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 ## Other responses - `400`: Bad request. Check fields message and error code from response body for additional information. - `401`: Unauthorized request. Check fields message and error code from response body for additional information. - `429`: Too many requests. Check response header Retry-After indicating how long to wait before making a new request. - `451`: Unavailable because account is not verified. --- [API](https://skmtc.dev/intheloop/apis/loop-api.md) - [All operations](https://skmtc.dev/intheloop/apis/loop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/intheloop/apis/loop-api/revisions/0892c5ba0787?raw)