Provider Groups

A group is a user-defined custom folder for organizing providers in your instance like 'Sales Tools' or 'Engineering'.

Provider Groups object

Attributes

object

String

String representing the object's type

id

String

Unique group identifier

name

String

Display name of the group

description

StringNullable

Description of the group

slug

String

URL-friendly identifier

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "object": "provider.group",
  "id": "pgr_3nPqRsTuVwXyZaBc",
  "name": "Sales Integrations",
  "description": "CRM and sales pipeline integrations for sales agents",
  "slug": "sales-integrations",
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

List provider groups

Returns a paginated list of provider groups.

Query Parameters

limit

NumberOptional

Maximum number of items to return (1-100)

after

StringOptional

Return items after this ID

before

StringOptional

Return items before this ID

cursor

StringOptional

Pagination cursor from a previous response

order

EnumOptional

Sort order for results

GEThttp://api.metorial.com/provider-groups
curl -X GET "https://api.metorial.com/provider-groups" \
  -H "Authorization: Bearer metorial_sk_..."

Get provider group

Retrieves a specific provider group by ID.

URL Parameters

provider_group_id

String

The unique identifier for the provider_group

GEThttp://api.metorial.com/provider-groups/:provider_group_id
curl -X GET "https://api.metorial.com/provider-groups/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create provider group

Creates a new custom provider group.

Request Body

name

String

description

StringOptional
POSThttp://api.metorial.com/provider-groups
curl -X POST "https://api.metorial.com/provider-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'

Update provider group

Updates an existing provider group.

URL Parameters

provider_group_id

String

The unique identifier for the provider_group

Request Body

name

StringOptional

description

StringOptional
PATCHhttp://api.metorial.com/provider-groups/:provider_group_id
curl -X PATCH "https://api.metorial.com/provider-groups/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'

Add listing to group

Adds a provider listing to a group.

URL Parameters

provider_group_id

String

The unique identifier for the provider_group

Request Body

provider_listing_id

String
POSThttp://api.metorial.com/provider-groups/:provider_group_id/listings
curl -X POST "https://api.metorial.com/provider-groups/pro_Rm4Mnheq2bfEPhBhP7SY/listings" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "provider_listing_id": "example_provider_listing_id"
}'

Remove listing from group

Removes a provider listing from a group.

URL Parameters

provider_group_id

String

The unique identifier for the provider_group

provider_listing_id

String

The unique identifier for the provider_listing

DELETEhttp://api.metorial.com/provider-groups/:provider_group_id/listings/:provider_listing_id
curl -X DELETE "https://api.metorial.com/provider-groups/pro_Rm4Mnheq2bfEPhBhP7SY/listings/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."