Workspaces

>>>

GET /api/V4/workspaces
Show workspace. Last update: 22/10/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 1,
  "name": "Scrum Launch",
  "available_users_count": 30,
  "can_add_new_users": true,
  "can_invite_users_count": 29,
  "workspace_users": [
    {
      "id": 21,
      "email": "kruchina.vadim+11@gmail.com",
      "user_full_name": "name ",
      "invited": true,
      "invite_id": 3,
      "workspace_role_name": "member",
      "avatar_image": null,
      "touch_role": "admin",
      "display_role": "no_role",
    },
    ...,
    {
      "id": 1,
      "email": "kruchina.vadim@gmail.com",
      "user_full_name": "Vadym Kruchyna",
      "invited": false,
      "invite_id": null,
      "workspace_role_name": "owner",
      "avatar_image": null,
      "touch_role": "admin",
      "display_role": "no_role",
    },
    ...
  ],
  "workspace_roles": [
    {
      "id": 1,
      "name": "owner"
    },
    {
      "id": 2,
      "name": "admin"
    },
    {
      "id": 3,
      "name": "member"
    }
  ]
}

Params

Param name Description
sort_by
optional

name by default

Validations:

  • Must be one of: name, email, workspace_role.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

PUT api/v4/workspaces
Update workspace. Last Update: 02/08/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

For update name
{
  "workspace": {
    "name": "name"
  }
}
For update organization_type
{
  "workspace": {
    "organization_type": "ORGANIZATION_TYPE",
    "custom_organization_type": "CUSTOM_ORGANIZATION_TYPE"
  }
}

Success response body ↑

{
  "id": 1,
  "name": "name",
  "available_users_count": 30,
  "can_add_new_users": true,
  "can_invite_users_count": 29
}

Params

Param name Description
workspace
required

Validations:

  • Must be a Hash
workspace[name]
optional

Validations:

  • Must be a String
workspace[organization_type]
optional

Validations:

  • Must be one of: Public High School, Private High School, College/University, Club/Youth Sports, Other/Not Listed, School District, K12 School, Higher Education, Youth/Club Sports, Other.
workspace[custom_organization_type]
optional

Validations:

  • Must be a String
workspace[timezone]
optional

IANA time zone string for iCal (Autocreate) display; owner only, stored as-is

Validations:

  • Must be a String
>>>

PUT api/v4/workspaces/timezone
Initial-set of the workspace time zone

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Notes ↑

Any workspace user may set the time zone, but ONLY while it is still blank.
Once a time zone is set, this endpoint returns 403; the owner edit path
(workspaces#update) must be used to change an already-set value.

Request body example ↑

{
  "timezone": "America/New_York"
}

Success response body ↑

{
  "id": 1,
  "name": "name",
  "available_users_count": 30,
  "timezone": "America/New_York"
}

Error response body (403) — beta gate (GP-16587, temporary) ↑

While CALENDARS_BETA_ENABLED=true only users granted `calendars_enabled`
may call this endpoint; open to everyone once the variable is off.
Distinguished from the already-set 403 above by the `code` field.
{
  "message": "This feature is not available for your account yet.",
  "code": "feature_not_available"
}

Errors

Code Description
forbidden The workspace time zone is already set and cannot be overwritten here

Params

Param name Description
timezone
required

IANA time zone string; stored as-is (no backend validation)

Validations:

  • Must be a String
>>>

GET api/v4/workspaces/can_use_site
Check workspace can use site?

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "can_use_site": true
}

Errors

Code Description Metadata
forbidden 
can_use_site: false