Retrieve Accounts
Retrieve a list of all accounts for the agency with the specified agencyId.
This endpoint requires authentication with a JWT token.
GET
https://api.instantuploader.com/business-accounts
Example:
/business-accounts
{
"accountId": "f09394dc775a870f9c7b8f98e45a",
"address": "",
"agencyId": "10d125c1277ac06295d25b79edc6",
"businessCategories": [],
"businessLabels": [],
"businessServices": [],
"businessTags": [],
"city": "",
"contentType": {
"id": "7eb49931fab86365a07f137db5fe",
"name": "Project"
},
"coordData": {
"geohash": ""
},
"coords": "44.00,44.0114",
"createDate": "2021-05-31T11:51:57.0Z",
"customerName": "",
"datetimeStamp": 516,
"description": "",
"internalNote": "",
"lock": {},
"media": [],
"neighborhood": "",
"permitNumber": "",
"pipelineId": "5c760838b1976bc7465b5fa8fff9",
"presentation": {},
"seo": {
"permalink": "title_"
},
"smartTags": [],
"stage": "1cb355e1ebaf70bb46eda2f6d3f9",
"status": {
"content": "draft",
"publish": "notPublished",
"service": "open"
},
"tasks": [],
"testimonial": {},
"title": "",
"updateDate": "2021-05-31T11:51:57.0Z",
"userId": "user_id",
"writings": {}
}
Example:
GET /business-accounts/{agencyId} HTTP/1.1
Host: api.instantuploader.com
Content-Type: application/json
Authorization: Bearer "<your_token_or_api_key>"
When you make a successful request to the /business-accounts/{agencyId} endpoint, you will receive a JSON object in the following format:
{
"agency": {
// Information About the Current Agency
},
"accounts": [
{
"id": "<account_id>",
"agencyBusinessName": "<agency_business_name>",
// Other fields specific to the account
},
// Additional account objects
]
}
The "agency" field contains information about the current agency, and the "accounts" field is an array of account objects, each containing information about a single account.
Each account object contains the following fields:
id
: The ID of the account.agencyBusinessName
: The business name of the agency associated with the account.Other fields specific to the account, as defined in the Instantuploader API documentation.
Limit of Results: 150
That's it! This is the format of the result object you can expect to receive when making a successful request to the /business-accounts/{agencyId} endpoint using the InstantUploader API.
Last updated