API REFERENCEv1

List Groups

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

⌘

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

Response parameters:

Parameter	Description
Id	Group Id
Name	Group name, string, characters count between 3 and 255 symbols
Note	Keyword Id, int, if equals to 0 means the group is not a keyword group, otherwise the group is attached to a keyword.
KeywordId	Parent Group Id, int, if equals to 0 means the group is a parent group, otherwise the group is a child group which parent group Id is ParentId.
DateCreated	The date when the record was created, string.
DateUpdated	The date when the record was updated, string.
PhoneNumberIds	PhoneNumber Ids, array of integers, the Ids of Phone Numbers in the group

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/groups/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 OK2 Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=03 Connection: Keep-Alive4 Content-Type: application/xml; charset=utf-85 Keep-Alive: timeout=5, max=1006 Link: <https://api2.protexting.com/v1/groups/?access_token=your_access_token&page=1>; rel=self7 Pragma: no-cache8 Transfer-Encoding: chunked9 X-Pagination-Current-Page: 110 X-Pagination-Page-Count: 111 X-Pagination-Per-Page: 10012 X-Pagination-Total-Count: 4613 X-Powered-By: PHP/5.6.214 X-Rate-Limit-Limit: 6015 X-Rate-Limit-Remaining: 5916 X-Rate-Limit-Reset: 0

Example Response Body:

JSON response example

1[
2    {
3        "Id": 1,
4        "Name": "Sweeps winners from Feb 1, 2015",
5        "Note": "Reminder: Send message to all members of the group to inform them if they're winners",
6        "KeywordId": 0,
7        "ParentId": 0,
8        "DateCreated": "2015-01-20 10:21:29",
9        "DateUpdated": "2015-01-20 10:41:29",
10        "PhoneNumberIds": [1,2]
11    },
12    {
13        "Id": 2,
14        "Name": "All participants under 21 years old",
15        "Note": "",
16        "KeywordId": 0,
17        "ParentId": 0,
18        "DateCreated": "2015-01-20 10:21:29",
19        "DateUpdated": "2015-01-20 10:41:29",
20        "PhoneNumberIds":[]
21    }
22]

XML response example

1<response>2   <item>3   <Id>1</Id>4   <Name>Sweeps winners from Feb 1, 2015</Name>5   <Note>Reminder: Send message to all members of the group to tell inform them if they're winners</Note>6   <KeywordId>0</KeywordId>7   <ParentId>0</ParentId>8   <DateCreated>2015-01-20 10:21:29</DateCreated>9   <DateUpdated>2015-01-20 10:41:29</DateUpdated>10   <PhoneNumberIds>11      <item>1</item>12      <item>2</item>13   </PhoneNumberIds>14   </item>15   <item>16      <Id>2</Id>17      <Name>All contacts under 21 years old</Name>18      <Note></Note>19      <KeywordId>0</KeywordId>20      <ParentId>0</ParentId>21      <DateCreated>2015-01-20 10:21:29</DateCreated>22      <DateUpdated>2015-01-20 10:41:29</DateUpdated>23      <PhoneNumberIds/>24   </item>25</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 »

← PreviousUndo Opt Out Contact Next →View Group

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