Skip to main content

ConversationFilter

No description

input ConversationFilter {
  afterCreatedAt: DateTime
  afterUpdatedAt: DateTime
  assigned: AssignedFilter
  beforeCreatedAt: DateTime
  beforeUpdatedAt: DateTime
  channelId: ID
  contactEmail: String
  contactId: ID
  customFields: [CustomFieldSearchInput!]
  deleted: Boolean
  draftAuthor: ID
  draftType: DraftType
  folderId: ID
  keywords: String
  mentionedAgent: ID
  rating: RatingEnum
  starred: Boolean
  state: ConversationState
  states: [ConversationState!]
  tag: ID
  tagName: String
  tagNames: [String!]
  tags: [ID!]
  type: [ConversationType!]
}

Fields

`ConversationFilter.afterCreatedAt` ● `DateTime` scalar common

Return conversations created on or after the specified date.

`ConversationFilter.afterUpdatedAt` ● `DateTime` scalar common

Return conversations updated on or after the specified date.

`ConversationFilter.assigned` ● `AssignedFilter` input common

Filters conversations by the assigned agent or team.

`ConversationFilter.beforeCreatedAt` ● `DateTime` scalar common

Return conversations created on or before the specified date.

`ConversationFilter.beforeUpdatedAt` ● `DateTime` scalar common

Return conversations updated on or before the specified date.

`ConversationFilter.channelId` ● `ID` scalar common

Filters conversations by the ID of a channel.

`ConversationFilter.contactEmail` ● `String` scalar common

Filters conversations by the email address of the contact that sent it.

`ConversationFilter.contactId` ● `ID` scalar common

Filters conversations by the ID of the contact that sent it.

`ConversationFilter.customFields` ● `[CustomFieldSearchInput!]` list input common

Filter conversations with the matching custom field values.

`ConversationFilter.deleted` ● `Boolean` scalar common

If true, filters by conversations that are trashed; if false, filters by conversations that are not trashed.

`ConversationFilter.draftAuthor` ● `ID` scalar common

Filters conversations that have drafts by the specified author ID.

`ConversationFilter.draftType` ● `DraftType` enum common

Filters conversations that have drafts by draft type.

`ConversationFilter.folderId` ● `ID` scalar common

Filters conversations by the ID of a folder.

`ConversationFilter.keywords` ● `String` scalar common

Searches for conversations that match the keywords.

`ConversationFilter.mentionedAgent` ● `ID` scalar common

Filters conversations that mention the specified agent ID.

`ConversationFilter.rating` ● `RatingEnum` enum common

Searches for conversations with a matching latest rating.

`ConversationFilter.starred` ● `Boolean` scalar common

If true, filters by conversations that are starred; if false, filters by conversations that are unstarred.

`ConversationFilter.state` ● `ConversationState` enum common

Filters conversations by status.

`ConversationFilter.states` ● `[ConversationState!]` list enum common

Filters conversations with any of the provided statuses. If state is also provided, this will be ignored.

`ConversationFilter.tag` ● `ID` scalar common

Filters conversations by the ID of a tag.

`ConversationFilter.tagName` ● `String` scalar common

Searches for conversations with the specified tag names.

`ConversationFilter.tagNames` ● `[String!]` list scalar common

Searches for conversations with the specified tag names.

`ConversationFilter.tags` ● `[ID!]` list scalar common

Filters conversations that has any of the provided tag ids. If provided with tag, the tag filter will be ignored.

`ConversationFilter.type` ● `[ConversationType!]` list enum common

Filters conversations by type.

Member of

conversations query

Fields
Member of