Retrieve Account

Retrieve information about an account

The /account endpoint provides access to information about a specific account, including basic details such as the account name, as well as more specific information such as the account's content types, pipelines, and so on.

To retrieve account information, you can specify the account ID as a query parameter in the API request. If you do not specify an account ID, the endpoint will return information about the parent account of the currently authenticated user.

To access this endpoint, you must provide authentication with a JWT token or API key. This ensures that only authorized users can access account information.

GET https://api.instantuploader.com/account

Example for Agency: /account/?accountId=00273d240422d0267bd17dc189d

Example for Account: /account

Query Parameters

Name	Type	Description
accountId	String	The ID of the account to retrieve all details of the account (required for agencies)

200: OK

403: Forbidden

Example:

HTTP

GET /api/account/{accountId} HTTP/1.1
Host: api.instantuploader.com
Content-Type: application/json
Authorization: Bearer "<your_token_or_api_key>" 

Node

PHP

Example response:

{
	"lastName": "Masliy",
	"country": "",
	"apiKey": "2d192edc-2976-4b5d-9cee-5ea22f479df3",
	"customFields": [
		{
			"uid": "fa698fa89d68c458fdd8aa055527",
			"name": "Datetime stamp",
			"require": false,
			"type": "",
			"contentTypes": [
				"bcca46a89a3458685862c758d9d8",
				"f3185b689d4e26de84c8bbc8aff7",
				"1ce83f488dcdefdc4378acea2838",
				"fa6fe5a7bdf831b853f53f983948"
			],
			"value": 965,
			"key": "datetimeStamp"
		},
		{
			"uid": "0b488dd81878d81d87382bd805a3",
			"name": "Media",
			"require": false,
			"type": "media",
			"contentTypes": [
				"bcca46a89a3458685862c758d9d8",
				"f3185b689d4e26de84c8bbc8aff7",
				"1ce83f488dcdefdc4378acea2838",
				"fa6fe5a7bdf831b853f53f983948"
			],
			"value": [
				{
					"updateDate": 1681253252917,
					"thumb": "https://firebasestorage.googleapis.com/v0/b/profolio-instantuploader-1ab31.appspot.com/o/image%2Fthumb%2F25f6a9184b68e2681d7855ac118d_dot_200x200.png?alt=media&token=0f5a6a52-71f6-4d4a-8144-1e7fa5d2e561",
					"alt": "",
					"description": "",
					"caption": "",
					"isMediaSourceMobileApp": false,
					"type": "video/mp4",
					"userId": "yJAWmutBZwMKi34sL0bEKKaoQfk1",
					"url": "https://firebasestorage.googleapis.com/v0/b/profolio-instantuploader-1ab31.appspot.com/o/video%2F6faa96524d08e61280b84fcdbb11_2023-04-10%2018-20-11.mp4?alt=media&token=c100ed7d-01e1-4cf7-b3c7-04fe2e9fe3e3",
					"videoHeight": 1386,
					"duration": 26.299866,
					"videoWidth": 1682,
					"uid": "6faa96524d08e61280b84fcdbb11",
					"thumbType": "image/png",
					"mediaTitle": "",
					"size": 2925868,
					"name": "2023-04-10 18-20-11.mp4",
					"autoTagsGenerated": false,
					"createDate": 1681253252917
				}
			],
			"key": "media"
		},
		{
			"uid": "df017c66b40873856658b9f80296",
			"name": "Title",
			"require": false,
			"type": "text",
			"contentTypes": [
				"bcca46a89a3458685862c758d9d8",
				"f3185b689d4e26de84c8bbc8aff7",
				"1ce83f488dcdefdc4378acea2838",
				"fa6fe5a7bdf831b853f53f983948"
			],
			"value": "",
			"key": "title"
		},
		{
			"uid": "00b8023d53f8af28311802736f31",
			"name": "Description",
			"require": false,
			"contentTypes": [
				"bcca46a89a3458685862c758d9d8",
				"f3185b689d4e26de84c8bbc8aff7",
				"1ce83f488dcdefdc4378acea2838",
				"fa6fe5a7bdf831b853f53f983948"
			],
			"type": "multiText",
			"value": "",
			"key": "description"
		},
		{
			"uid": "644328984c8812785068dc889e08",
			"name": "Coords",
			"require": false,
			"contentTypes": [
				"bcca46a89a3458685862c758d9d8",
				"f3185b689d4e26de84c8bbc8aff7",
				"1ce83f488dcdefdc4378acea2838"
			],
			"type": "map",
			"value": "",
			"key": "coords"
		},
		{
			"uid": "30b8f92114e8076814f854384a88",
			"name": "Address",
			"require": false,
			"type": "map",
			"contentTypes": [
				"bcca46a89a3458685862c758d9d8",
				"f3185b689d4e26de84c8bbc8aff7",
				"1ce83f488dcdefdc4378acea2838"
			],
			"value": "",
			"key": "address"
		},
		{
			"uid": "fb787426d4a8b4788cc8ceb14b28",
			"name": "Price",
			"require": false,
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"type": "number",
			"value": "",
			"key": "price"
		},
		{
			"uid": "7fe885a8c6cf8072abc8c4486668",
			"name": "Sale type",
			"require": false,
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"type": "select",
			"value": "",
			"key": "saleType"
		},
		{
			"uid": "438868e425df78dbd678f7ffed78",
			"name": "Listing status",
			"require": false,
			"type": "select",
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"value": "",
			"key": "listingStatus"
		},
		{
			"uid": "ca68849940fd181864b8b79fa348",
			"name": "MLS ID",
			"require": false,
			"type": "text",
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"value": "",
			"key": "mlsId"
		},
		{
			"uid": "1e5142856f48b912517809510b65",
			"name": "Home Size",
			"require": false,
			"type": "number",
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"value": "",
			"key": "homeSize"
		},
		{
			"uid": "befe693c37aaaaf8cf1ba0ad2542",
			"name": "Lot Size",
			"require": false,
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"type": "number",
			"value": "",
			"key": "lotSize"
		},
		{
			"uid": "658850f86c78d9b2fa1996c61858",
			"name": "Bedrooms Qty",
			"require": false,
			"type": "number",
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"value": "",
			"key": "bedroomsQty"
		},
		{
			"uid": "8c187e71f8c15cf3b71836b86707",
			"name": "Bathrooms Qty",
			"require": false,
			"contentTypes": [
				"f3185b689d4e26de84c8bbc8aff7"
			],
			"type": "number",
			"value": "",
			"key": "bathroomsQty"
		}
	],
	"businessName": "Test Account",
	"description": "",
	"agencyId": "3a1768b3724ffb64d9951a7f6196",
	"type": "account",
	"userWatermark": {
		"watermarkImage": "",
		"name": ""
	},
	"uid": "e108b6a946f3dd6879d8f944f268",
	"pipelines": [
		{
			"color": "#2F6F35",
			"stages": [
				{
					"color": "#05A2F3",
					"label": "New",
					"value": "New"
				},
				{
					"color": "#525E8A",
					"label": "In progress",
					"value": "In progress"
				},
				{
					"color": "#FF8022",
					"label": "Completed",
					"value": "Completed"
				},
				{
					"color": "#4CAF50",
					"label": "Published",
					"value": "Published"
				},
				{
					"color": "#D33832",
					"label": "Unpublished",
					"value": "Unpublished"
				}
			],
			"label": "Project",
			"id": "ba14ef68f6c8a81af58cd5ab55d8"
		},
		{
			"color": "#2F6F35",
			"stages": [
				{
					"color": "#05A2F3",
					"label": "Idea",
					"value": "Idea"
				},
				{
					"color": "#525E8A",
					"label": "Draft",
					"value": "Draft"
				},
				{
					"color": "#FF8022",
					"label": "Reviewing",
					"value": "Reviewing"
				},
				{
					"color": "#4CAF50",
					"label": "Completed",
					"value": "Completed"
				},
				{
					"color": "#D33832",
					"label": "Published",
					"value": "Published"
				}
			],
			"label": "Blog",
			"id": "4b4cbc37e69804474b37070b3418"
		},
		{
			"color": "#7B1FA2",
			"stages": [
				{
					"color": "#05A2F3",
					"label": "New",
					"value": "New"
				},
				{
					"color": "#525E8A",
					"label": "In progress",
					"value": "In progress"
				},
				{
					"color": "#4CAF50",
					"label": "Completed",
					"value": "Completed"
				}
			],
			"id": "38bf3b288458ef98125816981cf8",
			"label": "Default"
		}
	],
	"state": "",
	"businessCategories": [
		{
			"uid": "e174e394af534d2fdefbdeffe0f4",
			"industry": "6c0cf5d3a5748d033f29e9f1f998",
			"label": "Afghani Restaurant",
			"services": [
				{
					"uid": "649891c8e43e54780e284bf394a8",
					"label": "test",
					"labels": []
				},
				{
					"uid": "f5b88908b6181ab892b3b1181c68",
					"label": "adaD",
					"labels": [
						{
							"uid": "d7f80285e0a2861a71eec1e87ecc",
							"forContent": true,
							"label": "LABELTEST",
							"forMedia": true,
							"tags": []
						}
					]
				}
			]
		}
	],
	"themeValue": "Theme by agency",
	"email": "[email protected]",
	"createDate": {
		"_seconds": 1681246449,
		"_nanoseconds": 620000000
	},
	"zip": "",
	"website": "",
	"contentSmartTags": [],
	"firstName": "TestAccountBogdan",
	"subscriptionType": "free",
	"phone": "",
	"tokensMax30": "10000",
	"location": "",
	"contentTypes": [
		{
			"pipelines": "Project",
			"color": "#1471CB",
			"label": "Project",
			"id": "bcca46a89a3458685862c758d9d8",
			"pipelineId": "ba14ef68f6c8a81af58cd5ab55d8"
		},
		{
			"pipelines": "Blog",
			"color": "#7B1FA2",
			"label": "Blog",
			"id": "1ce83f488dcdefdc4378acea2838",
			"pipelineId": "4b4cbc37e69804474b37070b3418"
		},
		{
			"pipelines": "Default",
			"color": "#FF8022",
			"id": "f3185b689d4e26de84c8bbc8aff7",
			"label": "Listing",
			"pipelineId": "38bf3b288458ef98125816981cf8"
		},
		{
			"pipelines": "Default",
			"color": "#2F6F35",
			"label": "Testimonial",
			"id": "fa6fe5a7bdf831b853f53f983948",
			"pipelineId": "38bf3b288458ef98125816981cf8"
		}
	],
	"updated": 7,
	"whitelabelDomain": "dev21.instantuploader.com",
	"status": "Enabled"
}