Overview

Get Users And Teams which can be used to create calendars with

Request

GET /Calendar/usersAndTeams

Request Arguments

Name Type Description Required
module_list Array List of modules to retrieve. It can be Users or Teams or both False
q String Query string to filter the result False
offset Integer The offset to start from False

Response

The response will be an object containing the following:
Name Type Description
next_offset Integer Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records Array An array of results containing matched records.

Response Example

{
    "next_offset": -1,
    "records": [
        {
            "id": "seed_will_id",
            "name": "Will Westin",
            "_module": "Users"
        },
        {
            "id": "West",
            "name": "West",
            "_module": "Teams"
        },
        {
            "id": "aa574f1a-fb83-11eb-a5a9-0242ac140008",
            "name": "Will",
            "_module": "Teams"
        }
    ],
}

Change Log

Version Change
v11_14 Added /Calendar/usersAndTeams GET endpoint.
v11_15 Unified return parameters for Users and Teams records and removed teams_offset from response.