Viewing All Endpoints

Review the API reference documentation here to get the full list of your provisioned Companies. Recall that each Company gets an endpointID. An endpoint is the user/token's connection to their company file. Note that on the call the argument IsActive is optional. You can select all by not passing in IsActive or by passing in a value (true/false) you can select all the active (true) or not active (false).

Here's an example of a request:

curl --location --request GET '' \
--header 'x-api-key: {YOUR API KEY}' \

Here is the response:

	"Self": "",
	"Kind": "collection",
	"RequestId": "20A42B02674D4986B5F9B5B6D4B3023D",
	"Page": 1,
	"MoreData": null,
	"HasErrors": false,
	"Contents": [{
		"Object": {
			"isActive": true,
			"endpointId": "THE_ENDPOINT_ID",
			"endpoint": "qbd",
			"fullPath": "THE_FILE_PATH",
			"companyName": "THE_COMPANY_LABEL",
			"dateTimeCreated": "2020-04-09T18:55:07.843",
			"dateLastModified": "2020-04-09T18:55:07.843",
			"appName": "YOUR_APP_NAME",
			"userId": "THE_USER_ID",
			"token": "THE_USER_TOKEN"
		"Errors": null,
		"Self": "",
		"Kind": "collection"
	"Errors": []