Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:49 UTC

Get a Search Conversation Filter

GET /:account/conversation_filters/:conversation_filter{?q}

A SearchConversationFilter is a collection of contacts nested under a conversation filter

Examples

Getting the search conversation filter

Request

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

Response

Status

200

Response Type

ConversationFilter

Example
{
  "@type": "ConversationFilter",
  "id": "/my_account/conversation_filters/search?q=TextUs",
  "@context": "/contexts/ConversationFilter.jsonld",
  "slug": "search",
  "title": "Searched Conversations",
  "unansweredCount": 0,
  "unreadCount": 2,
  "totalCount": 3,
  "conversations": "/my_account/conversation_filters/search/conversations?q=TextUs",
  "closeConversations": "/my_account/conversation_filters/search/conversations/close?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "reopenConversations": "/my_account/conversation_filters/search/conversations/reopen?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "starConversations": "/my_account/conversation_filters/search/conversations/star?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "unstarConversations": "/my_account/conversation_filters/search/conversations/star?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "readConversations": "/my_account/conversation_filters/search/conversations/read?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "unreadConversations": "/my_account/conversation_filters/search/conversations/read?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "assignConversations": "/my_account/conversation_filters/search/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "unassignConversations": "/my_account/conversation_filters/search/conversations/assign?modified_before=2018-03-14T09:26:53.589793Z&q=TextUs",
  "searchConversations": "/my_account/conversation_filters/search/conversations{?q}",
  "subFilters": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/my_account/conversation_filters/search?sub_filters=true",
    "members": [],
    "totalItems": 0
  }
}

© 2021 TextUs