For more information on using API
GET https://webapi.mymarketing.co.il/api/groups?SearchTerm={SearchTerm}&Page={Page}&Limit={Limit}
Get account's groups
Request Information
URI Parameters
Name
Description
Type
Additional information
search_term
Group name to search for.
string
page
Get a specific page (number of pages is limited)
integer
Range: inclusive between 1 and 2147483647
limit
Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)
integer
Range: inclusive between 1 and 100
Body Parameters
None.
Response Information
Resource Description
Name
Description
Type
Additional information
id
id
integer
name
The group's name
string
active_counter
Number of active contacts in the group. Delete in a post/put endpoint.
integer
counter
Total contacts in the group. Delete in a post/put endpoint.
integer
created
Date of creation of the group. Delete in a post/put endpoint.
date
last_generated
Dynamic group only- the last time it generated contacts according to the group conditions
date
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"name": "sample string 2",
"active_counter": 3,
"counter": 4,
"created": "2016-12-24T14:12:12",
"last_generated": "2016-12-24T14:12:12"
},
{
"id": 1,
"name": "sample string 2",
"active_counter": 3,
"counter": 4,
"created": "2016-12-24T14:12:12",
"last_generated": "2016-12-24T14:12:12"
}
]
application/xml, text/xml
Sample:
<ArrayOfApiGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
<ApiGroup>
<active_counter>3</active_counter>
<counter>4</counter>
<created>2016-12-24T14:12:12</created>
<id>1</id>
<last_generated>2016-12-24T14:12:12</last_generated>
<name>sample string 2</name>
</ApiGroup>
<ApiGroup>
<active_counter>3</active_counter>
<counter>4</counter>
<created>2016-12-24T14:12:12</created>
<id>1</id>
<last_generated>2016-12-24T14:12:12</last_generated>
<name>sample string 2</name>
</ApiGroup>
</ArrayOfApiGroup>