---
title: "List Resources"
method: GET
path: "/setup/v1/resources"
tags: ["Resources"]
---

# List Resources

`GET /setup/v1/resources`

Use this endpoint to return a **List of Resources**. The results are returned in pages. 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.

## Query parameters

- `locationId` string
- `resourceGroupId` string
- `email` string
- `name` string
- `deleted` boolean
- `googleAuthReturnUrl` string
- `outlookAuthReturnUrl` string
- `offset` integer
- `limit` integer

## Response `200`

resource object

- ResourceListViewModel
  - `object` string, nullable
  - `url` string, nullable
  - `hasMore` boolean
  - `count` integer
  - `total` integer
  - `data` ResourceViewModel[], nullable
    - `object` string, nullable
    - `id` string, nullable
    - `locationId` string, nullable
    - `name` string, nullable
    - `email` string, nullable
    - `groupId` integer, nullable
    - `description` string, nullable
    - `imageUrl` string, nullable
    - `deletedStatus` boolean
    - `deletedTime` string, date-time, nullable
    - `notificationType` integer
    - `bookingNotification` integer
    - `googleCalendarId` string, nullable
    - `googleCalendarAuthorized` boolean
    - `googleCalendarAuthUrl` string, nullable
    - `outlookCalendarId` string, nullable
    - `outlookCalendarAuthUrl` string, nullable
    - `outlookCalendarAuthorized` boolean
    - `ignoreBusinessHours` boolean
    - `gender` string, nullable
    - `recurringAvailability` boolean, nullable
    - `hourly` number, double, nullable
    - `calendarAvailability` integer
    - `sortKey` integer
    - `skypeName` string, nullable
    - `bioLink` string, nullable
    - `timezoneOffset` integer, nullable
    - `timezoneId` string, nullable
    - `timezoneIana` string, nullable
    - `effectiveDate` string, date-time, nullable
    - `contact` ContactViewModel
      - `phoneType` string, nullable
      - `homePhone` string, nullable
      - `mobilePhone` string, nullable
      - `businessPhone` string, nullable
      - `businessPhoneExt` string, nullable
      - `skypeUsername` string, nullable
      - `conferenceInfo` string, nullable
    - `phone` PhoneViewModel
      - `phoneType` string, nullable
      - `homePhone` string, nullable
      - `mobilePhone` string, nullable
      - `businessPhone` string, nullable
      - `businessPhoneExt` string, nullable
    - `address` AddressViewModel
      - `addressLine1` string, nullable
      - `addressLine2` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country` string, nullable
      - `postalCode` string, nullable
    - `availability` ResourceHoursViewModel
      - `mon` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `tue` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `wed` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `thu` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `fri` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `sat` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
      - `sun` ResourceHourViewModel
        - `startTime` integer
        - `endTime` integer
    - `options` ResourceOptionsInputModel — Options for the new resource
      - `effectiveDate` string, date-time, nullable
      - `notificationType` integer, nullable — 0 = None, 1=Online Bookings 2=All Bookings.
      - `displayColor` string, nullable
      - `googleCalendarId` string, nullable
      - `outlookCalendarId` string, nullable
      - `ignoreBusinessHours` boolean, nullable
      - `gender` string, nullable
      - `hourly` number, double, nullable
      - `calendarAvailability` integer, nullable — 0 = OnSched Availability, 1 = Google Calendar, 2 = Outlook Calendar
      - `bookingNotification` integer, nullable
      - `sortKey` integer, nullable
      - `bioLink` string, nullable
    - `services` ResourceServiceViewModel[], nullable
      - `object` string, nullable
      - `serviceId` integer
      - `serviceName` string, nullable
    - `customFields` CustomFieldInputModel
      - `field1` string, nullable
      - `field2` string, nullable
      - `field3` string, nullable
      - `field4` string, nullable
      - `field5` string, nullable
      - `field6` string, nullable
      - `field7` string, nullable
      - `field8` string, nullable
      - `field9` string, nullable
      - `field10` string, nullable

## Other responses

- `400` — Missing or invalid values in the request
- `404` — Resource was not found

---

[API](https://skmtc.net/onsched/apis/onsched-setup-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-setup-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-setup-api/revisions/c5c023458a2f/schema)