Users in a Schedule

get

https://api.alocity.com/v1/integration-management/schedule/{scheduleId}/users

This endpoint is used to get all users either associated or not associated with a specific schedule depending on the value of the inSchedule flag in a paged form.

Response Payload Object

The response's payload will contain an array of objects containing the following values.

Property	Type	Description
email	string	The email of that user.
firstName	string	The first name of that user.
fullName	string	The combined first and last name of that user.
id	Guid	The Guid Id of that user.
lastName	string	The last name of that user.

🚧
Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.

📘
Note that if an error was found, then the payload will be null, however if no values were found and no error occurred, then an empty list will be returned instead.

Controlled Errors

Error Code	Error Message
error_schedule_not_found	No schedule with the provided Id was found.

Any status codes returned that are not provided here are generic status codes that can be found here.

Path Params

scheduleId

int64

required

The Id of the schedule.

Query Params

inSchedule

boolean

Whether to get the users in the schedule or not in the schedule. If this value is not passed, it will default to false.

combinedSearch

boolean

Whether or not to use the combined search. If this value is not passed, it will default to false.

combinedSearchStartsWith

string

Used to filter results wherever the value matches any user's first name, last name, or email.

emailStartsWith

string

Used to filter results wherever the value matches any user's email.

firstNameStartsWith

string

Used to filter results wherever the value matches any user's first name.

lastNameStartsWith

string

Used to filter results wherever the value matches any user's last name.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Response Payload Object

Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.

Note that if an error was found, then the payload will be null, however if no values were found and no error occurred, then an empty list will be returned instead.

Controlled Errors

200200

400400