Skip to main content
GET
Get provider channels by workspace id and provider type

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

messageProviderType
enum<string>
required

Message provider type (e.g. WHATSAPP, HEYGIA).

Available options:
WHATSAPP,
SMS,
TELEGRAM,
INSTAGRAM,
TWITTER,
LINE,
FACEBOOK,
IMESSAGE,
WHATSAPP_TEST,
HEYGIA

Query Parameters

brandId
string | null

Optional brand identifier. When supplied, only channels whose corporate line belongs to that brand are returned. Honored for WHATSAPP only; HEYGIA providers carry no brand.

Response

Successful Response

Response body for provider channels operations.

workspaceId
string
required

Unique identifier of the workspace (UUID v4).

Example:

"92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5"

providerChannels
ProviderChannel · object[]
required

List of provider channels (phone numbers) available for this workspace.