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
Request
- Base URLhttps://sandbox-api.onsched.com
- AuthOAuth 2Client credentialsToken URLhttps://sandbox-identity.onsched.com/connect/tokenScopesOnSchedApi
- TypeScripthttps://skmtc.dev/onsched/apis/onsched-setup-api/docs/setup/v1/businessusers/:email/companies/get.tsA function with typed inputs. Its response is checked against the schema.
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
Changes
No recorded changes to this operation across all 1 revision of this API.