Skip to main content
GET
/
v1
/
admin
/
overview
Get admin overview
curl --request GET \
  --url https://api.openworklabs.com/v1/admin/overview
{
  "viewer": {
    "id": "<string>",
    "email": "<string>",
    "name": "<string>"
  },
  "admins": [
    {}
  ],
  "summary": {},
  "users": [
    {}
  ],
  "generatedAt": "2023-11-07T05:31:56Z"
}

Query Parameters

includeBilling
string

Response

Administrative overview returned successfully.

viewer
object
required
admins
object[]
required
summary
object
required
users
object[]
required
generatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$