Retrieving an account
You can retrieve accounts by ID with the API described here:
GET https://driftapi.com/accounts/{accountId}
ex: GET https://driftapi.com/accounts/0bt5b47b-2a06-4816-883e-82592ZZ9908a
A successful request will result in a 200 response with the retrieved account in the response body (if the account exists).
{
"data": { // Account Model
"ownerId": 18807,
"name": "Kristin's company",
"domain": "kristinstest.com",
"accountId": "123458_kristinstest.com",
"deleted": true,
"createDateTime": 1518101450213,
"updateDateTime": 1537463118339,
"targeted": true,
"customProperties": { ... }
}
}
A note on unset fields
Note that unset fields on the returned
Account
object will be absent from the response body. We recommend checking existence first. Fields likeaccountId
anddomain
should always be set.
Getting accounts requires the account_read
scope.
Updated almost 3 years ago