Zum Hauptinhalt springen
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": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
conversations.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
inboxId
integer
required

The unique ID of the inbox.

Query Parameters

​
archived
boolean
default:false

Whether to include archived inboxes in the response.

Response

successful operation

​
createdAt
string<date-time>
required

When the inbox was created.

​
archived
boolean
required
​
name
string
required

The name of the inbox.

​
id
string
required

The ID of the inbox.

​
type
string
required

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

​
updatedAt
string<date-time>
required
​
archivedAt
string<date-time>