Conversation Filters

GET /:account/conversation_filters

Provides a list of all applicable ConversationFilters.

Examples

Getting the index

Request

GET /my_account/conversation_filters

Example

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

Response

Status

200

Response Type

ConversationFilterCollection

Example Body

{
  "@type": "ConversationFilterCollection",
  "id": "/my_account/conversation_filters",
  "@context": "/contexts/ConversationFilterCollection.jsonld",
  "totalItems": 5,
  "members": [
    {
      "@type": "ConversationFilter",
      "id": "/my_account/conversation_filters/all",
      "@context": "/contexts/ConversationFilter.jsonld",
      "slug": "all",
      "title": "All Conversations",
      "unreadCount": 0,
      "totalCount": 0,
      "closeConversations": "/my_account/conversation_filters/all/conversations/close?modified_before=2018-03-14T09:26:53.589793Z",
      "reopenConversations": "/my_account/conversation_filters/all/conversations/reopen?modified_before=2018-03-14T09:26:53.589793Z",
      "starConversations": "/my_account/conversation_filters/all/conversations/star?modified_before=2018-03-14T09:26:53.589793Z",
      "unstarConversations": "/my_account/conversation_filters/all/conversations/star?modified_before=2018-03-14T09:26:53.589793Z",
      "readConversations": "/my_account/conversation_filters/all/conversations/read?modified_before=2018-03-14T09:26:53.589793Z",
      "unreadConversations": "/my_account/conversation_filters/all/conversations/read?modified_before=2018-03-14T09:26:53.589793Z",
      "assignConversations": "/my_account/conversation_filters/all/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z",
      "unassignConversations": "/my_account/conversation_filters/all/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z",
      "searchConversations": "/my_account/conversation_filters/all/conversations{?q}",
      "conversations": "/my_account/conversation_filters/all/conversations",
      "subFilters": {
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "id": "/my_account/conversation_filters/open?sub_filters=true",
        "members": [
          {
            "@type": "ConversationFilter",
            "@context": "/contexts/ConversationFilter.jsonld",
            "id": "/my_account/conversation_filters/open?unanswered=true",
            "slug": "open",
            "title": "Open",
            "unreadCount": 0,
            "totalCount": 0,
            "conversations": "/my_account/conversation_filters/open/conversations?unanswered=true",
            "searchConversations": "/my_account/conversation_filters/open/conversations{?q}",
            "readConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "unreadConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "closeConversations": "/my_account/conversation_filters/open/conversations/close?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "reopenConversations": "/my_account/conversation_filters/open/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "starConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "unstarConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "assignConversations": "/my_account/conversation_filters/open/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "unassignConversations": "/my_account/conversation_filters/open/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/open?sub_filters=true",
              "members": [],
              "totalItems": 0
            }
          },
          {
            "@type": "ConversationFilter",
            "@context": "/contexts/ConversationFilter.jsonld",
            "id": "/my_account/conversation_filters/open?unread=true",
            "slug": "open",
            "title": "Open",
            "unreadCount": 0,
            "totalCount": 0,
            "conversations": "/my_account/conversation_filters/open/conversations?unread=true",
            "searchConversations": "/my_account/conversation_filters/open/conversations{?q}",
            "readConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "unreadConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "closeConversations": "/my_account/conversation_filters/open/conversations/close?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "reopenConversations": "/my_account/conversation_filters/open/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "starConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "unstarConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "assignConversations": "/my_account/conversation_filters/open/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "unassignConversations": "/my_account/conversation_filters/open/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/open?sub_filters=true",
              "members": [],
              "totalItems": 0
            }
          },
          {
            "@type": "ConversationFilter",
            "@context": "/contexts/ConversationFilter.jsonld",
            "id": "/my_account/conversation_filters/open?unanswered=true&unread=true",
            "slug": "open",
            "title": "Open",
            "unreadCount": 0,
            "totalCount": 0,
            "conversations": "/my_account/conversation_filters/open/conversations?unanswered=true&unread=true",
            "searchConversations": "/my_account/conversation_filters/open/conversations{?q}",
            "readConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "unreadConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "closeConversations": "/my_account/conversation_filters/open/conversations/close?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "reopenConversations": "/my_account/conversation_filters/open/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "starConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "unstarConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "assignConversations": "/my_account/conversation_filters/open/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "unassignConversations": "/my_account/conversation_filters/open/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/open?sub_filters=true",
              "members": [],
              "totalItems": 0
            }
          }
        ],
        "totalItems": 3
      }
    },
    {
      "@type": "ConversationFilter",
      "id": "/my_account/conversation_filters/all",
      "@context": "/contexts/ConversationFilter.jsonld",
      "slug": "all",
      "title": "All Conversations",
      "unreadCount": 0,
      "totalCount": 1,
      "closeConversations": "/my_account/conversation_filters/all/conversations/close?modified_before=2018-03-14T09:26:53.589793Z",
      "reopenConversations": "/my_account/conversation_filters/all/conversations/reopen?modified_before=2018-03-14T09:26:53.589793Z",
      "starConversations": "/my_account/conversation_filters/all/conversations/star?modified_before=2018-03-14T09:26:53.589793Z",
      "unstarConversations": "/my_account/conversation_filters/all/conversations/star?modified_before=2018-03-14T09:26:53.589793Z",
      "readConversations": "/my_account/conversation_filters/all/conversations/read?modified_before=2018-03-14T09:26:53.589793Z",
      "unreadConversations": "/my_account/conversation_filters/all/conversations/read?modified_before=2018-03-14T09:26:53.589793Z",
      "assignConversations": "/my_account/conversation_filters/all/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z",
      "unassignConversations": "/my_account/conversation_filters/all/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z",
      "searchConversations": "/my_account/conversation_filters/all/conversations{?q}",
      "conversations": "/my_account/conversation_filters/all/conversations",
      "subFilters": {
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "id": "/my_account/conversation_filters/open?sub_filters=true",
        "members": [
          {
            "@type": "ConversationFilter",
            "@context": "/contexts/ConversationFilter.jsonld",
            "id": "/my_account/conversation_filters/open?unanswered=true",
            "slug": "open",
            "title": "Open",
            "unreadCount": 0,
            "totalCount": 0,
            "conversations": "/my_account/conversation_filters/open/conversations?unanswered=true",
            "searchConversations": "/my_account/conversation_filters/open/conversations{?q}",
            "readConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "unreadConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "closeConversations": "/my_account/conversation_filters/open/conversations/close?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "reopenConversations": "/my_account/conversation_filters/open/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "starConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "unstarConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "assignConversations": "/my_account/conversation_filters/open/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.629556Z&unanswered=true",
            "unassignConversations": "/my_account/conversation_filters/open/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/open?sub_filters=true",
              "members": [],
              "totalItems": 0
            }
          },
          {
            "@type": "ConversationFilter",
            "@context": "/contexts/ConversationFilter.jsonld",
            "id": "/my_account/conversation_filters/open?unread=true",
            "slug": "open",
            "title": "Open",
            "unreadCount": 0,
            "totalCount": 0,
            "conversations": "/my_account/conversation_filters/open/conversations?unread=true",
            "searchConversations": "/my_account/conversation_filters/open/conversations{?q}",
            "readConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "unreadConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "closeConversations": "/my_account/conversation_filters/open/conversations/close?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "reopenConversations": "/my_account/conversation_filters/open/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "starConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "unstarConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "assignConversations": "/my_account/conversation_filters/open/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.634854Z&unread=true",
            "unassignConversations": "/my_account/conversation_filters/open/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/open?sub_filters=true",
              "members": [],
              "totalItems": 0
            }
          },
          {
            "@type": "ConversationFilter",
            "@context": "/contexts/ConversationFilter.jsonld",
            "id": "/my_account/conversation_filters/open?unanswered=true&unread=true",
            "slug": "open",
            "title": "Open",
            "unreadCount": 0,
            "totalCount": 0,
            "conversations": "/my_account/conversation_filters/open/conversations?unanswered=true&unread=true",
            "searchConversations": "/my_account/conversation_filters/open/conversations{?q}",
            "readConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "unreadConversations": "/my_account/conversation_filters/open/conversations/read?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "closeConversations": "/my_account/conversation_filters/open/conversations/close?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "reopenConversations": "/my_account/conversation_filters/open/conversations/reopen?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "starConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "unstarConversations": "/my_account/conversation_filters/open/conversations/star?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "assignConversations": "/my_account/conversation_filters/open/conversations/assign?modified_before=2019-11-27T18%3A49%3A52.640039Z&unanswered=true&unread=true",
            "unassignConversations": "/my_account/conversation_filters/open/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/open?sub_filters=true",
              "members": [],
              "totalItems": 0
            }
          }
        ],
        "totalItems": 3
      }
    }
  ]
}

---

Table of contents

• Search
• Get
• Batch Assign
• Batch Close
• Batch Read
• Batch Reopen
• Batch Star
• Batch Unassign
• Batch Unread
• Batch Unstar
• Converations