Get recently updated users API
GET /v2/users/recent/updated
Description:
This API request returns the users 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 users 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 users 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 users.
-
count: optional, specify the number of recently updated users 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 users along with their mapped attributes.
-
success: true or false.
-
total: the number of users.
-
offset: the offset to be used in the next api call.
-
has_more: true or false. When true, it means there are more users.
Other Status codes:
400: Bad request
401: Unauthorized
429: Too many requests
Example GET Request:
1. Example Request:
GET https://api.useriq.com/v2/users/recent/updated?since=1585070536000&offset=10&count=2
Example Response
{
"has_more": true,
"total": 2,
"offset": 12,
"success": true,
"result": [
{
"user_name": "Samuel Melendez",
"user_first_name": "Samuel",
"user_last_name": "Melendez",
"user_id": "44af10da-1ef3-4a2b-96a5-5eaf2f98e2da",
"account_id": "de10f67b-555a-4236-8131-9359bccbd6a5",
"created_at": "2020-11-03 17:35:35.276",
"attributes": [
{
"name": "User ID",
"source": "cvar",
"source_variable": "user_id",
"value": "44af10da-1ef3-4a2b-96a5-5eaf2f98e2da",
"data_type": "integer",
"created_a": "2020-11-03 17:35:35.282",
"updated_at": "2020-11-03 17:35:35.282"
},
{
"name": "User Name",
"source": "cvar",
"source_variable": "user_name",
"value": "Samuel Melendez",
"data_type": "string",
"created_a": "2020-11-03 17:35:35.288",
"updated_at": "2020-11-03 17:35:35.288"
},
{
"name": "Email Address",
"source": "cvar",
"source_variable": "email",
"value": "[email protected]",
"data_type": "string",
"created_a": "2020-11-03 17:35:35.292",
"updated_at": "2020-11-03 17:35:35.292"
},
{
"name": "Phone(Office)",
"source": "cvar",
"source_variable": "office_phone",
"value": "346-117-731",
"data_type": "string",
"created_a": "2020-11-03 17:35:35.297",
"updated_at": "2020-11-03 17:35:35.297"
},
{
"name": "On Account Since",
"source": "cvar",
"source_variable": "signup_date",
"value": "2020-04-24",
"data_type": "date",
"created_a": "2020-11-03 17:35:35.302",
"updated_at": "2020-11-03 17:35:35.302"
},
{
"name": "Signup Date",
"source": "cvar",
"source_variable": "signup_date",
"value": "2020-04-01",
"data_type": "date",
"created_a": "2020-11-03 17:35:35.306",
"updated_at": "2020-11-03 17:35:35.306"
},
{
"name": "Internal",
"source": "cvar",
"source_variable": "is_internal",
"value": "false",
"data_type": "boolean",
"created_a": "2020-11-17 16:19:04.924481",
"updated_at": "2020-11-17 16:19:04.924481"
},
{
"name": "Last Communication Date",
"source": "sfdc",
"source_variable": "last_user_comm_datetime(auto)",
"value": "2021-01-26T04:20:32.051878Z",
"data_type": "string",
"created_a": "2020-12-01 14:18:17.966",
"updated_at": "2021-01-28 04:20:32.051"
}
]
},
{
"user_name": "Brayden Decker",
"user_first_name": "Brayden",
"user_last_name": "Decker",
"user_id": "24774ae4-fbd7-4937-9b88-0873c5eb0310",
"account_id": "e94012c8-3b04-4c7e-b982-14b0934b46a2",
"created_at": "2020-11-03 17:35:52.141",
"attributes": [
{
"name": "User ID",
"source": "cvar",
"source_variable": "user_id",
"value": "24774ae4-fbd7-4937-9b88-0873c5eb0310",
"data_type": "integer",
"created_a": "2020-11-03 17:35:52.148",
"updated_at": "2020-11-03 17:35:52.148"
},
{
"name": "User Name",
"source": "cvar",
"source_variable": "user_name",
"value": "Brayden Decker",
"data_type": "string",
"created_a": "2020-11-03 17:35:52.153",
"updated_at": "2020-11-03 17:35:52.153"
},
{
"name": "Email Address",
"source": "cvar",
"source_variable": "email",
"value": "[email protected]",
"data_type": "string",
"created_a": "2020-11-03 17:35:52.159",
"updated_at": "2020-11-03 17:35:52.159"
},
{
"name": "Phone(Office)",
"source": "cvar",
"source_variable": "office_phone",
"value": "452-139-559",
"data_type": "string",
"created_a": "2020-11-03 17:35:52.164",
"updated_at": "2020-11-03 17:35:52.164"
},
{
"name": "On Account Since",
"source": "cvar",
"source_variable": "signup_date",
"value": "2020-10-09",
"data_type": "date",
"created_a": "2020-11-03 17:35:52.172",
"updated_at": "2020-11-03 17:35:52.172"
},
{
"name": "Signup Date",
"source": "cvar",
"source_variable": "signup_date",
"value": "2020-06-07",
"data_type": "date",
"created_a": "2020-11-03 17:35:52.178",
"updated_at": "2020-11-03 17:35:52.178"
},
{
"name": "Internal",
"source": "cvar",
"source_variable": "is_internal",
"value": "false",
"data_type": "boolean",
"created_a": "2020-11-17 16:19:04.924481",
"updated_at": "2020-11-17 16:19:04.924481"
},
{
"name": "Last Communication Date",
"source": "sfdc",
"source_variable": "last_user_comm_datetime(auto)",
"value": "2021-01-24T04:20:32.183105Z",
"data_type": "string",
"created_a": "2020-12-01 14:18:49.735",
"updated_at": "2021-01-28 04:20:32.183"
}
]
}
]
}
Comments
0 comments
Please sign in to leave a comment.