Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:49 UTC

Index

GET /:account/contact_filters

A Contact Filter is a set of rules used to match a subset of Contacts, and this endpoint is used to retrieve those matching Contacts. They are normally ordered alphabetically within the Collection, and support pagination

Examples

Get Contact Filters

Request

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

Response

Status

200

Response Type

hydra:Collection

Example
{
  "@type": "hydra:Collection",
  "id": "/my_account/contact_filters",
  "@context": "/contexts/hydra:Collection.jsonld",
  "totalItems": 3,
  "members": [
    {
      "@type": "ContactFilter",
      "id": "/my_account/contact_filters/all",
      "@context": "/contexts/ContactFilter.jsonld",
      "slug": "all",
      "title": "All Contacts",
      "path": "/my_account/contact_filters/all",
      "contacts": "/my_account/contact_filters/all/contacts",
      "blockContacts": "/my_account/contact_filters/all/contacts/block",
      "unblockContacts": "/my_account/contact_filters/all/contacts/block",
      "unsubscribeContacts": "/my_account/contact_filters/all/contacts/subscribe",
      "subscribeContacts": "/my_account/contact_filters/all/contacts/subscribe",
      "removeContacts": "/my_account/contact_filters/all/contacts"
    },
    {
      "@type": "ContactFilter",
      "id": "/my_account/contact_filters/all",
      "@context": "/contexts/ContactFilter.jsonld",
      "slug": "all",
      "title": "All Contacts",
      "path": "/my_account/contact_filters/all?q=saved+search",
      "contacts": "/my_account/contact_filters/all/contacts",
      "blockContacts": "/my_account/contact_filters/all/contacts/block",
      "unblockContacts": "/my_account/contact_filters/all/contacts/block",
      "unsubscribeContacts": "/my_account/contact_filters/all/contacts/subscribe",
      "subscribeContacts": "/my_account/contact_filters/all/contacts/subscribe",
      "removeContacts": "/my_account/contact_filters/all/contacts"
    },
    {
      "@type": "ContactFilter",
      "id": "/my_account/contact_filters/all",
      "@context": "/contexts/ContactFilter.jsonld",
      "slug": "all",
      "title": "All Contacts",
      "path": null,
      "contacts": "/my_account/contact_filters/all/contacts",
      "blockContacts": "/my_account/contact_filters/all/contacts/block",
      "unblockContacts": "/my_account/contact_filters/all/contacts/block",
      "unsubscribeContacts": "/my_account/contact_filters/all/contacts/subscribe",
      "subscribeContacts": "/my_account/contact_filters/all/contacts/subscribe",
      "removeContacts": "/my_account/contact_filters/all/contacts"
    }
  ]
}

Table of contents


© 2021 TextUs