v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB
BusinessUsers

List User Companies

Use this endpoint to return a List of Companies associated with the business users email requested. A business user email address is required. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

get/setup/v1/businessusers/{email}/companies

Path parameters

emailstring required

Email of business user

Query parameters

searchTextstring

All or partial company name

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

Success

objectstring nullable
urlstring nullable
hasMoreboolean
countinteger
totalinteger
emailstring nullable