Recently updated accounts API

Get recently updated accounts API

GET /v2/accounts/recent/updated

Description:

This API request returns the accounts whose one or more mapped attributes have changed recently.

E.g., Account ABC has a mapped attribute “Last Communication Date“. When this attribute changes recently, the account ABC will be returned with all its mapped attributes.

API Limit:

300 requests per minute. Client receives 429 once over the limit.

Method Details:

HTTP method: GET

Response format: JSON

Headers:

useriq-api-key: Your valid API key generated from the site settings page

Content-Type: application/json

Parameters:

The accounts may not be returned in a single API call, i.e., the results are paged. The following parameters are used to customize the paging results.

Query Parameters:

• since: optional, only return accounts updated after timestamp x. x must be a UNIX formatted timestamp in milliseconds. The default is the epochMilli 1 day ago. When since=0, it is equivalent to getting all accounts.

• count: optional, specify the number of recently updated accounts that are returned in one API call. Default is 500. The max can be set is 1000.

• offset: optional, this is to get the next page of results. Each request returns an offset in the response, and you’d use that offset in the next request to get the next page of results.

Response:

Status code 200:

The body contains

• result: a list of accounts along with their mapped attributes.

• success: true or false.

• total: the number of accounts.

• offset: the offset to be used in the next api call.

• has_more: true or false. When true, it means there are more accounts.

Other Status codes:

400: Bad request

401: Unauthorized

429: Too many requests

Example GET Request:

1. Example Request:
GET https://api.useriq.com/v2/accounts/recent/updated?since=1585070536000&offset=10&count=2
Example Response
{
    "has_more": true,
    "total": 2,
    "offset": 12,
    "success": true,
    "result": [
        {
            "account_id": "b3ffe504-2604-4660-a362-3d66e527d4b0",
            "account_name": "Plussunin Association",
            "created_at": "2020-11-03 17:35:16.397",
            "attributes": [
                {
                    "name": "MRR",
                    "source": "sfdc",
                    "source_variable": "mrr__c",
                    "value": "534.43",
                    "data_type": "currency",
                    "created_a": "2020-11-03 17:35:16.403",
                    "updated_at": "2020-11-03 17:35:16.403"
                },
                {
                    "name": "ARR",
                    "source": "sfdc",
                    "source_variable": "arr__c",
                    "value": "5860.82",
                    "data_type": "currency",
                    "created_a": "2020-11-03 17:35:16.408",
                    "updated_at": "2020-11-03 17:35:16.408"
                },
                {
                    "name": "Last Communication Contact",
                    "source": "sfdc",
                    "source_variable": "last_comm_contact(auto)",
                    "value": "Julia Valentine",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:16.427",
                    "updated_at": "2020-11-03 17:35:16.427"
                },
                {
                    "name": "Account Owner",
                    "source": "sfdc",
                    "source_variable": "CSM__c",
                    "value": "Austin Dunlap",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:16.435",
                    "updated_at": "2020-11-03 17:35:16.435"
                },
                {
                    "name": "Renewal Date",
                    "source": "api",
                    "source_variable": "renewal_date",
                    "value": "2021-05-07",
                    "data_type": "date",
                    "created_a": "2020-11-03 17:35:16.44",
                    "updated_at": "2020-11-03 17:35:16.44"
                },
                {
                    "name": "Plan Type",
                    "source": "api",
                    "source_variable": "plan_type",
                    "value": "Gold",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:16.445",
                    "updated_at": "2020-11-03 17:35:16.445"
                },
                {
                    "name": "Stage",
                    "source": "api",
                    "source_variable": "stage",
                    "value": "Renewal",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:16.45",
                    "updated_at": "2020-11-03 17:35:16.45"
                },
                {
                    "name": "Account ID",
                    "source": "cvar",
                    "source_variable": "account_id",
                    "value": "b3ffe504-2604-4660-a362-3d66e527d4b0",
                    "data_type": "integer",
                    "created_a": "2020-11-03 17:35:16.453",
                    "updated_at": "2020-11-03 17:35:16.453"
                },
                {
                    "name": "Account Name",
                    "source": "cvar",
                    "source_variable": "account_name",
                    "value": "Linger",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:16.457",
                    "updated_at": "2020-11-03 17:35:16.457"
                },
                {
                    "name": "Historical",
                    "source": "cvar",
                    "source_variable": "is_historical",
                    "value": "false",
                    "data_type": "boolean",
                    "created_a": "2020-11-03 17:35:16.46",
                    "updated_at": "2020-11-03 17:35:16.46"
                },
                {
                    "name": "Trial",
                    "source": "cvar",
                    "source_variable": "is_trial",
                    "value": "false",
                    "data_type": "boolean",
                    "created_a": "2020-11-03 17:35:16.463",
                    "updated_at": "2020-11-03 17:35:16.463"
                },
                {
                    "name": "Last Communication Date",
                    "source": "sfdc",
                    "source_variable": "last_account_comm_datetime(auto)",
                    "value": "2021-01-31T06:55:24.392230Z",
                    "data_type": "timestamp",
                    "created_a": "2020-12-01 13:46:00.227",
                    "updated_at": "2021-02-13 06:55:24.392"
                }
            ]
        },
        {
            "account_id": "173bb3fe-ea49-437b-95e6-97b8b8d83c30",
            "account_name": "Plusstrip Association",
            "created_at": "2020-11-03 17:35:12.109",
            "attributes": [
                {
                    "name": "MRR",
                    "source": "sfdc",
                    "source_variable": "mrr__c",
                    "value": "283.77",
                    "data_type": "currency",
                    "created_a": "2020-11-03 17:35:12.117",
                    "updated_at": "2020-11-03 17:35:12.117"
                },
                {
                    "name": "ARR",
                    "source": "sfdc",
                    "source_variable": "arr__c",
                    "value": "7247.99",
                    "data_type": "currency",
                    "created_a": "2020-11-03 17:35:12.123",
                    "updated_at": "2020-11-03 17:35:12.123"
                },
                {
                    "name": "Last Communication Contact",
                    "source": "sfdc",
                    "source_variable": "last_comm_contact(auto)",
                    "value": "Kaylee Arnold",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:12.146",
                    "updated_at": "2020-11-03 17:35:12.146"
                },
                {
                    "name": "Account Owner",
                    "source": "sfdc",
                    "source_variable": "CSM__c",
                    "value": "Avery Knapp",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:12.154",
                    "updated_at": "2020-11-03 17:35:12.154"
                },
                {
                    "name": "Plan Type",
                    "source": "api",
                    "source_variable": "plan_type",
                    "value": "Gold",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:12.165",
                    "updated_at": "2020-11-03 17:35:12.165"
                },
                {
                    "name": "Stage",
                    "source": "api",
                    "source_variable": "stage",
                    "value": "Adoption",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:12.171",
                    "updated_at": "2020-11-03 17:35:12.171"
                },
                {
                    "name": "Account ID",
                    "source": "cvar",
                    "source_variable": "account_id",
                    "value": "173bb3fe-ea49-437b-95e6-97b8b8d83c30",
                    "data_type": "integer",
                    "created_a": "2020-11-03 17:35:12.174",
                    "updated_at": "2020-11-03 17:35:12.174"
                },
                {
                    "name": "Account Name",
                    "source": "cvar",
                    "source_variable": "account_name",
                    "value": "Nonos",
                    "data_type": "string",
                    "created_a": "2020-11-03 17:35:12.179",
                    "updated_at": "2020-11-03 17:35:12.179"
                },
                {
                    "name": "Historical",
                    "source": "cvar",
                    "source_variable": "is_historical",
                    "value": "false",
                    "data_type": "boolean",
                    "created_a": "2020-11-03 17:35:12.182",
                    "updated_at": "2020-11-03 17:35:12.182"
                },
                {
                    "name": "Trial",
                    "source": "cvar",
                    "source_variable": "is_trial",
                    "value": "false",
                    "data_type": "boolean",
                    "created_a": "2020-11-03 17:35:12.186",
                    "updated_at": "2020-11-03 17:35:12.186"
                },
                {
                    "name": "Renewal Date",
                    "source": "api",
                    "source_variable": "renewal_date",
                    "value": "2021-09-13",
                    "data_type": "date",
                    "created_a": "2020-11-03 17:35:12.159",
                    "updated_at": "2020-12-02 06:51:36.783"
                },
                {
                    "name": "Last Communication Date",
                    "source": "sfdc",
                    "source_variable": "last_account_comm_datetime(auto)",
                    "value": "2021-01-26T06:57:19.278317Z",
                    "data_type": "timestamp",
                    "created_a": "2020-12-01 13:45:55.723",
                    "updated_at": "2021-02-14 06:57:19.278"
                }
            ]
        }
    ]
}