Resource: Accounts (preliminary)

Topics:

Actions

  • - (Object) index

Url:

  • [GET] /rest/v1/report/accounts?[arguments]
Note:

This action requires admin access.

Returns the total number of accounts.

Arguments:

  • (String) account_status

    (optional) Filter by account status. Values: ‘all’ (default), ‘new’, ‘active’, ‘suspended’, ‘closed’.

  • (String) billing_status

    (optional) Filter by billing status. Values: ‘all’ (default), ‘approved’, ‘good_standing’, ‘payment_past_due’, ‘payment_rejected’, ‘no_card_on_file’, ‘card_invalid’.

  • (Integer) offer_id

    (optional) Filter by offer id.

Example Request:

https://service_name.synctv.com/rest/v1/report/accounts?account_status=active

Example Response:

<ssap>
  <response>
    <code>1</code>
    <message>Successfully completed.</message>
    <count>1</count>
  </response>
  <version>0.5</version>
  <account_total>14</account_total>
</ssap>

Response Fields:

  • (Integer) account_total

    Total number of accounts.