API Reference

Get all Resources

get
https://api.vcita.biz/v3/scheduling/resources

Overview

Get all resources, with pagination and filtering by resource type or service.

Available for Staff Tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 10000
Defaults to 1

Page number of results

number
1 to 1000
Defaults to 25

How many items to return per page. Max: 1000

string
Defaults to updated_at:desc

Sort by fields. Example: sort=created_at:asc,updated_at:desc

resource_type_uid
array of strings

Filter by resource type UID(s). Accepts single value or array of values. Example: ?resource_type_uid=abc123 or ?resource_type_uid=abc123&resource_type_uid=def456

resource_type_uid
string

Filter resources by service UID that requires their resource type

boolean
Defaults to false

Include deleted resources in the response

uid
array of strings

Filter by resource UID(s). Accepts single value or array of values. Example: ?uid=abc123 or ?uid=abc123&uid=def456

uid
Responses

302

OAuth redirect when no authentication token provided

401

Valid business context is required

408

Request exceeded timeout limit

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago