Get All Spaces

URL: https://api.gradual-api.com/public-api/v1/spaces

HTTP Method: GET

Content type: application/json

Tier: Medium

Response Example:

[
    {
        "name": "Space 1",
        "description": "Space description is optional"
    },
    {
        "name": "Space 2"
    }
]

Update User Space Assignments

URL: https://api.gradual-api.com/public-api/v1/updateUserSpacesByEmail

HTTP Method: POST

Content type: application/json

Tier: Medium

Request Body Parameters:

• email, string, required, this is the unique identifier to find and update user
• spaces, string or array of strings, this parameter accepts either:
  • an array of space names to be assigned, or
  • one string value of space names separated by semicolon (recommended) or comma
• mode, string, one of "override" or "add"
  • "add" mode would add user to all spaces specified in spaces, user's previous space assignments will not be affected
  • "override" mode would wipe out any previous space assignments of this user, before assigning the user to the spaces specified by spaces
  • Use mode = "override" with spaces = [] to remove user from all spaces

Response Example:

{
    "userEmail": "[email protected]",
    "userId": "654d6623ea532ea2ac8ced28",
    "userFirstName": "John",
    "userLastName": "Smith",
    "oldSpaces": [
        "Space 1"
    ],
    "newSpaces": [
        "Space 1",
        "Space 2"
    ]
}