Workspaces

Get a workspace

GET/v1/workspaces/{workspaceId}

A workspace you're in: its name, your role and its owner.

curl "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "id": "6adfzfbkkmqkkjjgtm8tt8h54t2wtpet",
  "name": "Luigi's Pizza",
  "role": "owner",
  "ownerId": "rawdtm0emq4xn8qandnpmasxq9rcpsae"
}

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.

idstringrequired
The workspace's id.
namestringrequired
roleenumrequired
Your role in the workspace, owner or member. An API key counts as a member.
One of "owner", "member"
ownerIdstringrequired
The owner's user id.

Errors answer with a status and the error shape.