Get Appointments by User Id
Lets you retrieve appointments for multiple users by passing their user Ids.
- Pass a “FromDate” and “ToDate” within which you want to retrieve appointments. The difference between the from and to date cannot be more than 100 days.
- Pass one or more user Ids in the “Users” parameter.
The API response returns all appointment details including system and custom fields.
API URL
URL
POST
https://{host}/v2/Task.svc/RetrieveAppointments/ByUserId? accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
Request Parameters
| Parameter | Description |
|---|---|
| FromDate | Starting date to retrieve appointments from. |
| ToDate | End date you want to retrieve appointments till. |
| Users | You can pass multiple user Ids here. |
| Paging | Use “PageIndex” to specify the number of pages to return and “PageSize” to indicate the number of records you want returned per page. |
Response
200 OK
Content-Type: application/json
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
