public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add API documentation for GET /api/subscriptions/:listId

Browse source
This commit is contained in:
Gerard Krol 2017-11-06 10:34:55 +00:00
parent 0073989430
commit ac09ba81dd
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
views/users/api.hbs
View file

@ -43,6 +43,27 @@
</ul>
</div>
<h3>GET /api/subscriptions/:listId – {{#translate}}Get list of subscriptions{{/translate}}</h3>
<p>
{{#translate}}Retrieve a list of subscriptions to the list referenced by :listId. All fields of the subscribers will be returned.{{/translate}}
</p>
<p>
<strong>GET</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>access_token</strong> – {{#translate}}your personal access token{{/translate}}
<li><strong>start</strong> – {{#translate}}Start position{{/translate}} (<em>{{#translate}}optional, default 0{{/translate}}</em>)</li>
<li><strong>limit</strong> – {{#translate}}limit subscription count in response{{/translate}} (<em>{{#translate}}optional, default 10000{{/translate}}</em>)</li>
</ul>
<p>
<strong>{{#translate}}Example{{/translate}}</strong>
</p>
<pre>curl -XGET '{{serviceUrl}}api/subscriptions/B16uVTdW?access_token={{accessToken}}&limit=10&start=0' </pre>
<h3>POST /api/subscribe/:listId – {{#translate}}Add subscription{{/translate}}</h3>
<p>