v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Retrieve Message Channel

This API endpoint retrieves a specific message channel in your portal.

get/v1/message-channels/{id}

Path parameters

idstring required

The ID of the message channel to retrieve.

Response

200

idstring

objectstring

createdAtstring

updatedAtstring

membershipTypestring

clientIdstring

companyIdstring

membershipEntityIdstring

memberIdsstring[]

{"stackTrail":"paths:/v1/message-channels/{id}:get:responses:200:content:application/json:schema:properties:lastMessageDate","oasType":"schema","type":"unknown"}

Example response

{
  "id": "09660260-1e80-40a2-999c-d2255a33aff1",
  "object": "messageChannel",
  "createdAt": "2023-07-14T19:34:58.199614Z",
  "updatedAt": "2023-07-14T19:34:58.199614Z",
  "membershipType": "company",
  "clientId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "companyId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "membershipEntityId": "09660260-1e80-40a2-999c-d2255a33aff1",
  "memberIds": [
    "638f3dc4-0a9c-4585-9b74-60bcdca1b30a"
  ]
}