Skip to main content
GET
/
workspaces
/
info
Get Workspace Information
curl --request GET \
  --url https://api.luminpdf.com/v1/workspaces/info \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "created_at": 123,
  "total_members": 123,
  "total_spaces": 123
}
This endpoint requires one of the following scopes:workspaces.read or workspaces

Authorizations

​
X-API-Key
string
header
required

Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.

Response

Returns the information of the authorized Workspace.

​
id
string

The unique identifier of the Workspace.

​
name
string

The name of the Workspace.

​
owner
string

The email address of the Workspace owner.

​
created_at
integer<unix-epoch>

The time the Workspace was created.

​
user_role
enum<string>

The role of the current user in the Workspace.

Available options:
owner,
admin,
member
​
total_members
integer

The number of Workspace members.

​
total_spaces
integer

The number of Spaces in the Workspace.