Skip to main content
GET
/
api
/
settings
Get workspace settings
curl --request GET \
  --url https://api.staging.whilst.app/api/settings \
  --cookie whilst_session=
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "status": "active",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
whilst_session
string
cookie
required

JWT session token for authenticated users

Response

Workspace settings retrieved

​
id
string<uuid>
required
​
name
string
required

Workspace display name

​
slug
string
required

Unique workspace identifier (WorkOS org ID)

​
status
enum<string>
required
Available options:
active,
suspended,
cancelled
​
metadata
object

Additional workspace metadata

​
createdAt
string<date-time>
​
updatedAt
string<date-time>