Try Free for 14 DaysRequest A Demo

API Documentation - Accounts

The accounts resource allows you to retrieve, edit, add, and delete accounts.

Accounts Instance Resources

MethodEndpointDescription
GET/api/v1/accountsGet a paginated list of details for all accounts.
GET/api/v1/accounts/{account_id}Get details about a single account.
POST/api/v1/accountsCreate a new account.
POST/api/v1/accounts/{account_id}Edit details for a single account.
DELETE/api/v1/accounts/{account_id}Delete a single account.

Get All Accounts

Get a paginated list of details for all accounts.

Resource Details

MethodEndpoint
GEThttps://app.whatconverts.com/api/v1/accounts

Supported Parameters

ParameterTypeDescriptionRequired
accounts_per_pagenumberNumber of accounts to return for this request (default 25, maximum 250).No
page_numbernumberPage number to return for this request.No
start_datestringStart date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z.No
end_datestringEnd date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z.No
orderstringOrder in which to return the accounts by date created; asc or (default) desc.No

Response Details

ParameterTypeDescription
accounts_per_pagenumberThe number of accounts returned in the request.
page_numbernumberThe current page number in the request.
total_pagesnumberThe total amount of pages available in the request.
total_accountsnumberThe total amount of accounts available in the request.
accountsarrayContains all the requested accounts.
account_idnumberUnique identifier for the account.
account_namestringThe name of the account.
date_createdstringDate and time when the account was created in ISO 8601 format (UTC).
profilesarrayContains all the profiles under within the requested accounts.
profile_idnumberUnique identifier for the profile.
profile_namestringThe name of the profile.
date_createdstringDate and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "page_number": 1,
      "accounts_per_page": 25,
      "total_pages": 2,
      "total_accounts": 45,
      "accounts": [
        {
          "account_id": 5411295,
          "account_name": "WhatConverts",
          "date_created": "2016-06-24T17:24:42Z",
          "profiles": [ 
            {
              "profile_id": 2548713,
              "profile_name": "WhatConverts Tracking",
              "date_created": "2016-06-24T17:24:42Z"
            },
            ...
          ]
        },
        ...
      ]
    }
    

Get Single Account

Get details for specific account.

Resource Details

MethodEndpoint
GEThttps://app.whatconverts.com/api/v1/accounts/{account_id}

Supported Parameters

No supported parameters.

Response Details

Includes all response details from get all accounts resource.

Create New Account

Create a new account.

Resource Details

MethodEndpoint
POSThttps://app.whatconverts.com/api/v1/accounts

Supported Parameters

ParameterTypeDescriptionRequired
account_namestringThe name for this account.Yes
create_profilebooleanCreate a profile with the same name as the account; (default) true or false.No

Response Details

ParameterTypeDescription
account_idnumberUnique identifier for the account.
account_namestringThe name of the account.
date_createdstringDate and time when the account was created in ISO 8601 format (UTC).
profilesarrayContains all the profiles under within the requested accounts.
profile_idnumberUnique identifier for the profile.
profile_namestringThe name of the profile.
date_createdstringDate and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "account_id": 5411295,
      "account_name": "WhatConverts",
      "date_created": "2016-06-24T17:24:42Z",
      "profiles": [ 
        {
          "profile_id": 2548713,
          "profile_name": "WhatConverts",
          "date_created": "2016-06-24T17:24:42Z"
        }
      ]
    }
    

Edit Account

Edit details for a single account.

Resource Details

MethodEndpoint
POSThttps://app.whatconverts.com/api/v1/accounts/{account_id}

Supported Parameters

ParameterTypeDescriptionRequired
account_namestringThe name for this account.Yes

Response Details

ParameterTypeDescription
account_idnumberUnique identifier for the account.
account_namestringThe name of the account.
date_createdstringDate and time when the account was created in ISO 8601 format (UTC).
profilesarrayContains all the profiles under within the requested accounts.
profile_idnumberUnique identifier for the profile.
profile_namestringThe name of the profile.
date_createdstringDate and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "account_id": 5411295,
      "account_name": "WhatConverts",
      "date_created": "2016-06-24T17:24:42Z",
      "profiles": [ 
        {
          "profile_id": 2548713,
          "profile_name": "WhatConverts",
          "date_created": "2016-06-24T17:24:42Z"
        }
      ]
    }
    

Delete Account

Delete a single account.

Resource Details

MethodEndpoint
DELETEhttps://app.whatconverts.com/api/v1/accounts/{account_id}

Supported Parameters

No supported parameters.

Response Details

ParameterTypeDescription
account_idnumberUnique identifier for the account.

Example Response

    {
      "account_id": 5411295
    }