API REFERENCEv1

List Forbidden Words

GEThttps://api2.protexting.com/v1/forbidden-words/index

⌘

Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →

Response parameters:

Parameter	Description
Value	String

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/forbidden-words/index?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json'

Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example

1Status Code: 200 OK
2Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
3Connection: Keep-Alive
4Content-Type: application/xml; charset=utf-8
5Keep-Alive: timeout=5, max=100
6Link: <https://api2.protexting.com/v1/forbidden-words/index?access_token=your_access_token>; 7rel=self Pragma: no-cache Transfer-Encoding: chunked X-Pagination-Current-Page: 1 X-Pagination-Page-Count: 1 X-Pagination-Per-Page: 100 X-Pagination-Total-Count: 46 X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-Reset: 0

Example Response Body:

JSON response example

1[
2    {
3    	"Value":"kike"
4    },
5    {
6    	"Value":"spooge"
7    }
8]

XML response example

1<response>
2    <item>
3    	<Value>4            kike5        </Value>
6    </item>
7    <item>8        <Value>
9    	    spoge10        </Value>
11    </item>
12</response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

← PreviousList Campaign Queue Messages Next →Forbidden Words & Phrases

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.