Retrieve a Keyword Filter List

Retrieve a keyword filter list. Returns the list name, keywords, and the campaigns that the keyword filter list is associated with.

Endpoint

GET /v1/filter-words/{filterWordsId}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

filterWordsId REQUIRED

string (UUID)

Unique ID assigned to the keyword filter list in RocketCOMS.

Request Body

None

Returns

Returns the Keyword Filter List object. This object contains the list name, keywords, and the campaigns that the keyword filter list is associated with.

SAMPLE RESPONSE

				
					{
  "id": "582df7c3-76da-408e-b1bc-c6bc00414e5b",
  "name": "Keyword Filters",
  "words": [
    "blocked-word1",
    "blocked-word2",
    "blocked-word3"
  ],
  "campaigns": [
    {
      "brandId": "5c068161-206c-4178-b5b1-be4f6e5ce807",
      "brandName": "ABC Mobile",
      "campaignId": "8538e413-b1fe-42c8-b575-4f1f3735811f",
      "campaignName": "Spring Campaign"
    }
  ]
}