conversationMemberships

Fetch paginated conversation memberships collection

Arguments

active_status · String · Filters memberships by status. Accepted values: active (default), archived, closed.

client_id · String · ID of the client whose conversations to filter by.

conversation_type · String · Filters by conversation type. Accepted values: all (default), community, individual, internal_team.

keywords · String · Filters conversations by keyword search.

notes_type · String · Filters by note type. Accepted values: inbox (default), scheduled.

only_include_shared_memberships · Boolean · If true with client_id, only returns client messages that are shared with the provider.

org_chat · Boolean · If true, fetches organization members conversations.

provider_id · ID · ID of the provider to get conversations for. If null, returns the current user's conversations.

provider_ids · [ID] · Used to filter org chat conversations by provider IDs.

read_status · String · Filters by read status. Accepted values: all (default), read, unread.

order_by · ConversationMembershipOrderKeys · Specifies the sort order for results.

after · String · Returns the elements in the list that come after the specified cursor.

before · String · Returns the elements in the list that come before the specified cursor.

first · Int · Returns the first _n_ elements from the list.

last · Int · Returns the last _n_ elements from the list.

Returns

ConversationMembershipPaginationConnection

Example

query conversationMemberships(
  $active_status: String
  $client_id: String
  $conversation_type: String
  $keywords: String
  $notes_type: String
  $only_include_shared_memberships: Boolean
  $org_chat: Boolean
  $provider_id: ID
  $provider_ids: [ID]
  $read_status: String
  $order_by: ConversationMembershipOrderKeys
  $after: String
  $before: String
  $first: Int
  $last: Int
) {
  conversationMemberships(
    active_status: $active_status
    client_id: $client_id
    conversation_type: $conversation_type
    keywords: $keywords
    notes_type: $notes_type
    only_include_shared_memberships: $only_include_shared_memberships
    org_chat: $org_chat
    provider_id: $provider_id
    provider_ids: $provider_ids
    read_status: $read_status
    order_by: $order_by
    after: $after
    before: $before
    first: $first
    last: $last
  ) {
    edges
    nodes
    page_info
    total_count
  }
}