Link Search Menu Expand Document

Updated Tue Sep 21st 2021, 21:50 UTC

Get a Conversation Filter

GET /:account/conversation_filters/:conversation_filter

A ConversationFilter is a pre-made search for Conversations.

Examples

Getting the conversation filter

Request

GET /my_account/conversation_filters/you
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /my_account/conversation_filters/you
    

Response

Status

200

Response Type

ConversationFilter

Example
{
  "@type": "ConversationFilter",
  "id": "/my_account/conversation_filters/you",
  "@context": "/contexts/ConversationFilter.jsonld",
  "slug": "you",
  "title": "Your Conversations",
  "unansweredCount": 0,
  "unreadCount": 0,
  "totalCount": 0,
  "conversations": "/my_account/conversation_filters/you/conversations",
  "closeConversations": "/my_account/conversation_filters/you/conversations/close?modified_before=2018-03-14T09:26:53.589793Z",
  "reopenConversations": "/my_account/conversation_filters/you/conversations/reopen?modified_before=2018-03-14T09:26:53.589793Z",
  "starConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2018-03-14T09:26:53.589793Z",
  "unstarConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2018-03-14T09:26:53.589793Z",
  "readConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2018-03-14T09:26:53.589793Z",
  "unreadConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2018-03-14T09:26:53.589793Z",
  "assignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z",
  "unassignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z",
  "searchConversations": "/my_account/conversation_filters/you/conversations{?q}",
  "subFilters": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/my_account/conversation_filters/you?sub_filters=true",
    "members": [
      {
        "@type": "ConversationFilter",
        "@context": "/contexts/ConversationFilter.jsonld",
        "id": "/my_account/conversation_filters/you?unanswered=true",
        "slug": "you",
        "title": "Assigned to You",
        "unansweredCount": 0,
        "unreadCount": 0,
        "totalCount": 0,
        "conversations": "/my_account/conversation_filters/you/conversations?unanswered=true",
        "searchConversations": "/my_account/conversation_filters/you/conversations{?q}",
        "readConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "unreadConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "closeConversations": "/my_account/conversation_filters/you/conversations/close?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "reopenConversations": "/my_account/conversation_filters/you/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "starConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "unstarConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "assignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "unassignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
        "subFilters": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/my_account/conversation_filters/you?sub_filters=true",
          "members": [],
          "totalItems": 0
        }
      },
      {
        "@type": "ConversationFilter",
        "@context": "/contexts/ConversationFilter.jsonld",
        "id": "/my_account/conversation_filters/you?unread=true",
        "slug": "you",
        "title": "Assigned to You",
        "unansweredCount": 0,
        "unreadCount": 0,
        "totalCount": 0,
        "conversations": "/my_account/conversation_filters/you/conversations?unread=true",
        "searchConversations": "/my_account/conversation_filters/you/conversations{?q}",
        "readConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "unreadConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "closeConversations": "/my_account/conversation_filters/you/conversations/close?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "reopenConversations": "/my_account/conversation_filters/you/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "starConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "unstarConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "assignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "unassignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
        "subFilters": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/my_account/conversation_filters/you?sub_filters=true",
          "members": [],
          "totalItems": 0
        }
      },
      {
        "@type": "ConversationFilter",
        "@context": "/contexts/ConversationFilter.jsonld",
        "id": "/my_account/conversation_filters/you?unanswered=true&unread=true",
        "slug": "you",
        "title": "Assigned to You",
        "unansweredCount": 0,
        "unreadCount": 0,
        "totalCount": 0,
        "conversations": "/my_account/conversation_filters/you/conversations?unanswered=true&unread=true",
        "searchConversations": "/my_account/conversation_filters/you/conversations{?q}",
        "readConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "unreadConversations": "/my_account/conversation_filters/you/conversations/read?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "closeConversations": "/my_account/conversation_filters/you/conversations/close?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "reopenConversations": "/my_account/conversation_filters/you/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "starConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "unstarConversations": "/my_account/conversation_filters/you/conversations/star?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "assignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "unassignConversations": "/my_account/conversation_filters/you/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
        "subFilters": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/my_account/conversation_filters/you?sub_filters=true",
          "members": [],
          "totalItems": 0
        }
      }
    ],
    "totalItems": 3
  }
}

© 2021 TextUs