Waitlists

Get waitlist details with the list of participants. A waitlist is a queue that includes participants without a scheduled appointment.
Resource
/connect/scheduling/waitlists
Resource example
https://yourInstance.salesforce.com/services/data/v64.0/connect/scheduling/waitlists?waitlistIds=0010000XKJSMEDD
https://yourInstance.salesforce.com/services/data/v64.0/connect/scheduling/waitlists?waitlistIds=0010000XKJSMEDD,0010000XKJSMEDD
https://yourInstance.salesforce.com/services/data/v64.0/connect/scheduling/waitlists?serviceTerritoryId=0010000XKJSMEDD&isActive=true
https://yourInstance.salesforce.com/services/data/v64.0/connect/scheduling/waitlists?waitlistIds=0010000XKJSMEDD&participantFields=Source__c
Available version
59.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
isActive Boolean Indicates whether to fetch the active waitlists (true) or inactive waitlists (false). Used when the serviceTerritoryId parameter is specified. Optional 59.0
maxLimit Integer Batch size of the waitlist participant records to fetch for each waitlist ID or service territory ID. The default value is 50. Optional 59.0
offset Integer Number of waitlist participant records to skip from the response, in ascending order as per the created date. The default value is 0. The maximum offset value is 2000. Optional 59.0
participant​Fields String[] Comma-separated list of fields to fetch from the waitlist participant object. Optional 59.0
requestId String

For internal use only.

Optional 59.0
service​TerritoryId String ID of the service territory to fetch the details of the waitlists. Required if the waitlistIds parameter isn’t specified. 59.0
waitlist​Ids String Comma-separated list of the waitlist IDs to filter the result. Required if the serviceTerritoryId parameter isn’t specified. 59.0
Response body for GET
Waitlist Output