Consumer Surfaces

List and retrieve consumer surfaces for an instance.

Consumer Surfaces object

Attributes

object

String

id

String

status

Enum

name

String

description

StringNullable

auth

Object

created_at

Date

updated_at

Date
{
  "object": "consumer.surface",
  "id": "example_id",
  "status": "active",
  "name": "example_name",
  "description": "example_description",
  "auth": {
    "object": "consumer.surface.auth",
    "session_expiry_time_in_seconds": 0,
    "email_whitelist": [
      "example_item"
    ]
  },
  "created_at": "2026-04-16T08:42:33.487Z",
  "updated_at": "2026-04-16T08:42:33.487Z"
}

Get consumer surface

Retrieves a consumer surface by ID.

URL Parameters

consumer_surface_id

String

The unique identifier for the consumer_surface

GEThttp://api.metorial.com/consumer-surfaces/:consumer_surface_id
curl -X GET "https://api.metorial.com/consumer-surfaces/con_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."