Get list of allowed words

GET /api/v3/allowlists

Get list of allowed words

cURL

curl --request GET \
  --url https://apix.us.amity.co/api/v3/allowlists \
  --header 'Authorization: Bearer <token>'

200

{
  "results": [
    {
      "ruleId": "<string>",
      "regex": "<string>",
      "isDeleted": true,
      "isEnabled": true,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "paging": {
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

regex · string

search keyword from start

sortBy · enum<string>

Available options: firstCreated, lastCreated

options · object

Show child attributes

Response

200

application/json

Criteria info

results · object[]

Show child attributes

paging · object

Show child attributes