API REFERENCEv1

List Keywords

GEThttps://api2.protexting.com/v1/keyword/index

⌘

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

Response parameters:

Parameter	Description
Id	Keyword ID
Name	Keyword Name
Date_Reserved	Reserve Date
Number	Short Code or Long Number
Status_Id	Keyword Status ID »
Satus_Description	Keyword Status Description »

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/keyword/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/keyword/index?access_token=your_access_token&page=1>; 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: 10 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    	"Id": 100,
4        "Keyword": "MyKeyword",5        "Date_Reserved":"2015-02-10",6        "Number":"82257",7        "Status_Id":1,8        "Status_Description":"Active"
9    },
10    ..........
11]

XML response example

1<response>
2    <item>
3    	<Id>100</Id>
4        <Keyword>MyKeyword</Keyword>5        <Date_Reserved>2015-02-10</Date_Reserved>6        <Number>82257</Number>7        <Status_Id>1</Status_Id>8        <Status_Description>Active</Status_Description>
9    </item>10    ........................................
11</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 »

Statuses

Status_Id	Status_Description
1	Active
0	Not Active

← PreviousList Messages Next →Check Keyword Availability

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