List

1min
A pageable list of accounts. The account list contains a pagination object that indicates if more accounts exist via the next field, whose value is a URL that can be used to fetch the next page. If the next field is not present, that indicates there are no further accounts in the list.
GET
Request
Query Parameters
status
String
optional
Possible values are 'trial', 'paying', 'churned' or 'not_converted' 
archived
Boolean
optional
if true only archived accounts are listed
offset
Number
optional
What offset of results to fetch.
limit
Number
optional
How many results per page. Defaults 25, max is 100 
order
String
optional
Returns the accounts in ascending or descending order.
Valid values 'asc' or 'desc'. Default to 'desc'
sort
String
optional
What field to sort the results by. Valid value 'created_at'
Curl

curl -X GET https://data.successeve.com/v2/accounts \
-H 'Accept: application/json'
-H 'Authorization:Bearer <Your access token>'
curl -X GET https://data.successeve.com/v2/accounts \
-H 'Accept: application/json'
-H 'Authorization:Bearer <Your access token>'
Responses
200
404
{
  "object": "account.list",
  "data": [
    {
      "object": "account",
      "id": "5d3bae5bcb4a287b44583a55",
      "unique_id": "5d3bae4cf92ea13a3dfb542e",
      "created_at": 1564192347,
      "data": {
          ...
        },
      "salesmachine": {
          ...
       },
      "stage": {
        "name": "Trial",
        "id": "5b2bc014ce8d8355c6d48b70"
      },
      "contacts": {
        "object": "contact.list",
        "data": [
          {
            "id": "5d3bae278cae234bef95405a"
          }
        ]
      }
    }
  ],
  "pagination": {
    "total": 4019,
    "offset": 0,
    "limit": 25,
    "count": 25,
    "next": "https://data.successeve.com/v2/accounts?offset=25&limit=25"
  }
}

{
  "object": "account.list",
  "data": [
    {
      "object": "account",
      "id": "5d3bae5bcb4a287b44583a55",
      "unique_id": "5d3bae4cf92ea13a3dfb542e",
      "created_at": 1564192347,
      "data": {
          ...
        },
      "salesmachine": {
          ...
       },
      "stage": {
        "name": "Trial",
        "id": "5b2bc014ce8d8355c6d48b70"
      },
      "contacts": {
        "object": "contact.list",
        "data": [
          {
            "id": "5d3bae278cae234bef95405a"
          }
        ]
      }
    }
  ],
  "pagination": {
    "total": 4019,
    "offset": 0,
    "limit": 25,
    "count": 25,
    "next": "https://data.successeve.com/v2/accounts?offset=25&limit=25"
  }
}
﻿
﻿
Did this page help you?
Accounts
Get