Portal Listings

Read the shared listings available on a portal surface.

Portal Listings object

Attributes

object

Enumconsumer.access_listing

id

String

name

String

description

StringNullable

readme

StringNullable

access

Union

groups

Array of Objects

created_at

Date

updated_at

Date
{
  "object": "consumer.access_listing",
  "id": "example_id",
  "name": "example_name",
  "description": "example_description",
  "readme": "example_readme",
  "access": {
    "type": "provider_template",
    "provider_template": {
      "object": "provider.template#preview",
      "id": "example_id",
      "status": "active",
      "name": "example_name",
      "description": "example_description",
      "metadata": {},
      "integration_id": "example_integration_id",
      "created_at": "2026-07-21T06:58:12.675Z",
      "updated_at": "2026-07-21T06:58:12.675Z"
    }
  },
  "groups": [
    {},
    {}
  ],
  "created_at": "2026-07-21T06:58:12.675Z",
  "updated_at": "2026-07-21T06:58:12.675Z"
}

Get portal listing

Retrieves one shared listing for a portal.

URL Parameters

portal_id

String

The unique identifier for the portal

listing_id

String

The unique identifier for the listing

GEThttps://api.metorial.com/portals/:portal_id/listings/:listing_id
curl -X GET "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/listings/lis_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create portal listing

Creates a shared listing for a portal.

URL Parameters

portal_id

String

The unique identifier for the portal

Request Body

name

StringOptional

description

StringOptionalNullable

readme

StringOptionalNullable

access

Union
POSThttps://api.metorial.com/portals/:portal_id/listings
curl -X POST "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/listings" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "readme": "example_readme",
  "access": {
    "type": "provider_template",
    "provider_template_id": "example_provider_template_id"
  }
}'

Update portal listing

Updates listing metadata for a portal listing.

URL Parameters

portal_id

String

The unique identifier for the portal

listing_id

String

The unique identifier for the listing

Request Body

name

StringOptional

description

StringOptionalNullable

readme

StringOptionalNullable
PATCHhttps://api.metorial.com/portals/:portal_id/listings/:listing_id
curl -X PATCH "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/listings/lis_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "readme": "example_readme"
}'

Delete portal listing

Deletes a portal listing and all consumer access attached to it.

URL Parameters

portal_id

String

The unique identifier for the portal

listing_id

String

The unique identifier for the listing

DELETEhttps://api.metorial.com/portals/:portal_id/listings/:listing_id
curl -X DELETE "https://api.metorial.com/portals/por_Rm4Mnheq2bfEPhBhP7SY/listings/lis_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."