in app surfaces reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

GET /v1/in-app-surfaces

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Request

Supply these values as query parameters. Path parameters remain in the URL.

unknown

Response

JSON response shape

{ surfaces: never[];
  }

JSON response shape

{ surfaces: { id: string;
  identifier: string;
  name: string;
  description: string | null;
  status: "active" | "inactive" | "archived";
  updatedAt: string;
  response: InAppSurfaceResponse;
  }[];
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleListInAppSurfaceCatalog.