Resources

Get Resource

Use this endpoint to return a Resource object. A valid resource id is required. Find resource id's by using the: GET /setup/v1/resources endpoint.

get/setup/v1/resources/{id}

Request

Base URL
https://sandbox-api.onsched.com
Auth
OAuth 2
Client credentials
Token URLhttps://sandbox-identity.onsched.com/connect/token
ScopesOnSchedApi
TypeScript
https://skmtc.dev/onsched/apis/onsched-setup-api/docs/setup/v1/resources/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

id of resource object

Query parameters

googleAuthReturnUrlstring

Google calendar authorization return url

outlookAuthReturnUrlstring

Outlook calendar authorization return url

Response

Success

objectstring nullable

idstring nullable

locationIdstring nullable

namestring nullable

emailstring nullable

groupIdinteger nullable

descriptionstring nullable

imageUrlstring nullable

deletedStatusboolean

deletedTimestring date-time nullable

notificationTypeinteger

bookingNotificationinteger

googleCalendarIdstring nullable

googleCalendarAuthorizedboolean

googleCalendarAuthUrlstring nullable

outlookCalendarIdstring nullable

outlookCalendarAuthUrlstring nullable

outlookCalendarAuthorizedboolean

ignoreBusinessHoursboolean

genderstring nullable

recurringAvailabilityboolean nullable

hourlynumber double nullable

calendarAvailabilityinteger

sortKeyinteger

skypeNamestring nullable

bioLinkstring nullable

timezoneOffsetinteger nullable

timezoneIdstring nullable

timezoneIanastring nullable

effectiveDatestring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.