Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 13:14 UTC

Get Contact Filter

GET /:account/contact_filters/:contact_filter{?q}

A ContactFilter is a pre-made search for Contacts. Some useful defaults are provided by us, and Users may create their own based on saved search results.

Examples

Get a Contact Filter

Request

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

Response

Status

200

Response Type

ContactFilter

Example
{
  "@type": "ContactFilter",
  "id": "/my_account/contact_filters/all?q=optional",
  "@context": "/contexts/ContactFilter.jsonld",
  "slug": "all",
  "title": "My Contacts",
  "path": null,
  "contacts": "/my_account/contact_filters/all/contacts?q=optional",
  "blockContacts": "/my_account/contact_filters/all/contacts/block?q=optional",
  "unblockContacts": "/my_account/contact_filters/all/contacts/block?q=optional",
  "unsubscribeContacts": "/my_account/contact_filters/all/contacts/subscribe?q=optional",
  "subscribeContacts": "/my_account/contact_filters/all/contacts/subscribe?q=optional",
  "removeContacts": "/my_account/contact_filters/all/contacts?q=optional"
}

Get a custom Contact Filter

Request

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

Response

Status

200

Response Type

ContactFilter

Example
{
  "@type": "ContactFilter",
  "id": "/my_account/contact_filters/search:aBj5Rk6",
  "@context": "/contexts/ContactFilter.jsonld",
  "slug": "search:aBj5Rk6",
  "title": "My Contacts",
  "path": "/my_account/contact_filters/all?q=lucille%20bluth",
  "contacts": "/my_account/contact_filters/search:aBj5Rk6/contacts",
  "blockContacts": "/my_account/contact_filters/search:aBj5Rk6/contacts/block",
  "unblockContacts": "/my_account/contact_filters/search:aBj5Rk6/contacts/block",
  "unsubscribeContacts": "/my_account/contact_filters/search:aBj5Rk6/contacts/subscribe",
  "subscribeContacts": "/my_account/contact_filters/search:aBj5Rk6/contacts/subscribe",
  "removeContacts": "/my_account/contact_filters/all/contacts"
}

© 2021 TextUs