List Groups


URL:

https://api2.protexting.com/v1/groups/index?access_token=your_access_token


Method:

GET

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:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/groups/index?access_token=your_access_token"

 

Example Response Headers:

 Status Code: 200 OK
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Type: application/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/groups/?access_token=your_access_token&page=1>; rel=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:

[
    {
        "Id": 1,
        "Name": "Sweeps winners from Feb 1, 2015",
        "Note": "Reminder: Send message to all members of the group to inform them if they're winners",
        "KeywordId": 0,
        "ParentId": 0,
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:41:29",
        "PhoneNumberIds": [1,2]
    },
    {
        "Id": 2,
        "Name": "All participants under 21 years old",
        "Note": "",
        "KeywordId": 0,
        "ParentId": 0,
        "DateCreated": "2015-01-20 10:21:29",
        "DateUpdated": "2015-01-20 10:41:29",
        "PhoneNumberIds":[]
    }
]
<response>
<item>
<Id>1</Id>
<Name>Sweeps winners from Feb 1, 2015</Name>
<Note>Reminder: Send message to all members of the group to tell inform them if they're winners</Note>
<KeywordId>0</KeywordId>
<ParentId>0</ParentId>
<DateCreated>2015-01-20 10:21:29</DateCreated>
<DateUpdated>2015-01-20 10:41:29</DateUpdated>
<PhoneNumberIds>
<item>1</item>
<item>2</item>
</PhoneNumberIds>
</item>
<item>
<Id>2</Id>
<Name>All contacts under 21 years old</Name>
<Note></Note>
<KeywordId>0</KeywordId>
<ParentId>0</ParentId>
<DateCreated>2015-01-20 10:21:29</DateCreated>
<DateUpdated>2015-01-20 10:41:29</DateUpdated>
<PhoneNumberIds/>
</item>
</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 »