Get All (Customers of Reseller)

Get All (Customers of Reseller) #

Gets all Customers for a Reseller

GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers?pageIndex={pageIndex}&pageSize={pageSize}&filter={filter}

Parameters Description
pageIndex 0 based index to allow querying of pages
pageSize Page size to be returned by the request. Max 1,000
filter Optional filter parameter to search for customers by 'name' and 'reference' fields. A 'Contains' search is performed on any string provided.
Color Wand tip
Remember to URL encode the filter parameter.

Example #

This request will get all the child Customer tenants for provided ACCOUNT_TENANT_ID.

Request # 

GET <https://api.na.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers?pageIndex=0&pageSize=20> HTTP/1.1
Authorisation: Bearer {TOKEN}

Response # 

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"page_size": 4,
	"page_index": 0,
	"data": [{
			"id": "{CUSTOMER_TENANT_ID_1}",
			"name": "Customer 1",
			"description": "This is Customer 1",
			"enabled": true,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 1",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_2}",
			"name": "Customer 2",
			"description": "This is Customer 2",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 2",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_3}",
			"name": "Customer 3",
			"description": "This is Customer 3",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 3",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_4",
			"name": "Customer 4",
			"description": "This is Customer 4",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 4",
			"dateCreated": "2019-01-01T09:00:00.000"
		}
	][{
			"id": "{CUSTOMER_TENANT_ID_1}",
			"name": "Customer 1",
			"description": "This is Customer 1",
			"enabled": true,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 1",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_2}",
			"name": "Customer 2",
			"description": "This is Customer 2",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 2",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_3}",
			"name": "Customer 3",
			"description": "This is Customer 3",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 3",
			"dateCreated": "2019-01-01T09:00:00.000"
		}, {
			"id": "{CUSTOMER_TENANT_ID_4",
			"name": "Customer 4",
			"description": "This is Customer 4",
			"enabled": false,
			"parentTenantId": "{ACCOUNT_TENANT_ID}",
			"reference": "customer reference 4",
			"dateCreated": "2019-01-01T09:00:00.000"
		}
	],
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired 

HTTP/1.1 401 Unauthorised