Skip to main content
GET
Get a surface

Authorizations

Authorization
string
header
required

An ility API key, such as ilk_1a2b3c4d_…. Workspace owners create keys under Settings → API keys.

Path Parameters

id
string<uuid>
required

Response

OK

id
string<uuid>
required
workspace_id
string<uuid>
required
group_id
string<uuid> | null
required
type
enum<string>
required
Available options:
web
name
string
required
config
object
required
domain_id
string<uuid> | null
required
status
enum<string>
required
Available options:
active,
archived
archived_at
string<date-time> | null
required
domain
object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required