Skip to main content
Python
from openlayer import Openlayer

client = Openlayer()
client.workspaces.retrieve(workspace_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Openlayer",
  "slug": "openlayer",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectCount": 1,
  "memberCount": 1,
  "inviteCount": 1,
  "periodStartDate": "2023-11-07T05:31:56Z",
  "periodEndDate": "2023-11-07T05:31:56Z",
  "status": "active",
  "wildcardDomains": [
    "<string>"
  ],
  "monthlyUsage": [
    {
      "monthYear": "2023-12-25",
      "predictionCount": 1,
      "executionTimeMs": 1
    }
  ],
  "samlOnlyAccess": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
workspaceId
string<uuid>
required

The workspace id.

Response

Response OK.

​
id
string<uuid>
required

The workspace id.

​
name
string
required

The workspace name.

Maximum string length: 80
Example:

"Openlayer"

​
slug
string
required

The workspace slug.

Maximum string length: 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"openlayer"

​
dateCreated
string<date-time>
required

The workspace creation date.

​
dateUpdated
string<date-time>
required

The workspace last updated date.

​
creatorId
string<uuid> | null
required

The workspace creator id.

​
projectCount
integer
required

The number of projects in the workspace.

Required range: x >= 0
​
memberCount
integer
required

The number of members in the workspace.

Required range: x >= 0
​
inviteCount
integer
required

The number of invites in the workspace.

Required range: x >= 0
​
periodStartDate
string<date-time> | null
required

The start date of the current billing period.

​
periodEndDate
string<date-time> | null
required

The end date of the current billing period.

​
status
enum<string>
required
Available options:
active,
past_due,
unpaid,
canceled,
incomplete,
incomplete_expired,
trialing,
paused
​
wildcardDomains
string[]
​
monthlyUsage
object[]
​
samlOnlyAccess
boolean

Whether the workspace only allows SAML authentication.