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",
  "status": "active",
  "auth": {
    "object": "consumer.surface.auth"
  }
}

List consumer surfaces

Returns a paginated list of consumer surfaces for an instance.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

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

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_..."