Overview
This request will return a subset of all your transactional mails groups. Use the page and count parameters to get the whole list. You can include the order, direction and filter variables to affect the list you receive as request variables.
The Method
| API | - | Method |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/trans_groups/ |
| XML-RPC | Call | transactional._groups.ListTransactionalGroups |
Your URL is the address of your Everlytic install.
Your method must be structured as follows:
ListTransactionalGroups(string $search, int $page, int $count, string $order, string $direction) : array
Parameters
| Property | Type | Description | Default |
|---|---|---|---|
| $search | string | Match group names containing a specific keyword. | no |
| $page | integer | The page number of the list. | no |
| $count | integer | The number of results to return per page. | no |
| $order | string | The name of the field to order the listing with. | no |
| $direction | string | The direction of the ordering: ‘asc’ or ‘desc’. | no |
Responses
| Type | Description |
|---|---|
| array | An array of transactional mail groups. |