GET
/
conversations
/
v3
/
conversations
/
inboxes
/
{inboxId}
Get a single conversations inbox
curl --request GET \
  --url https://api.hubapi.com/conversations/v3/conversations/inboxes/{inboxId} \
  --header 'Authorization: Bearer <token>'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "archived": true,
  "name": "<string>",
  "id": "<string>",
  "type": "HELP_DESK",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • conversations.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

successful operation

​
archived
boolean
required
​
type
string
required

Specifies whether this refers to a Conversations Inbox or to the Help Desk. Valid values are INBOX or HELP_DESK

Example:

"HELP_DESK"

​
createdAt
string<date-time>

When the inbox was created.

​
archivedAt
string<date-time>
​
name
string

The name of the inbox.

​
id
string

The ID of the inbox.

​
updatedAt
string<date-time>