> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Intercom Retrieve Collection: Inputs, Cost & CLI Example
> Retrieve a collection. Intercom Intercom Retrieve Collection docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_retrieve_collection:{"collection_id":"{{collection_id}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | -------------------------------------------------------------------- |
| `payload.collection_id` | `integer` | Yes | | The unique identifier for the collection which is given by Intercom. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/ `.",
"properties": {
"collection_id": {
"type": "integer",
"description": "The unique identifier for the collection which is given by Intercom."
}
},
"required": [
"collection_id"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | | Collections are top level containers for Articles within the Help Center. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Collections are top level containers for Articles within the Help Center.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the collection which is given by Intercom."
},
"workspace_id": {
"type": "string",
"description": "The id of the workspace which the collection belongs to."
},
"name": {
"type": "string",
"description": "The name of the collection. For multilingual collections, this will be the name of the default language's content."
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language."
},
"created_at": {
"type": "integer",
"description": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.",
"format": "date-time"
},
"updated_at": {
"type": "integer",
"description": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.",
"format": "date-time"
},
"url": {
"type": [
"string",
"null"
],
"description": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language."
},
"icon": {
"type": [
"string",
"null"
],
"description": "The icon of the collection."
},
"order": {
"type": "integer",
"description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order."
},
"default_locale": {
"type": "string",
"description": "The default locale of the help center. This field is only returned for multilingual help centers."
},
"translated_content": {
"type": [
"object",
"null"
],
"description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - group_translated_content.",
"enum": [
null,
"group_translated_content"
]
},
"ar": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"bg": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"bs": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"ca": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"cs": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"da": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"de": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"el": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"en": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"es": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"et": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"fi": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"fr": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"he": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"hr": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"hu": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"id": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"it": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"ja": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"ko": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"lt": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"lv": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"mn": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"nb": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"nl": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"pl": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"pt": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"ro": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"ru": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"sl": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"sr": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"sv": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"tr": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"vi": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"pt-BR": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"zh-CN": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
},
"zh-TW": {
"type": [
"object",
"null"
],
"description": "The Content of a Group.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "The type of object - `group_content` .",
"enum": [
null,
"group_content"
]
},
"name": {
"type": "string",
"description": "The name of the collection or section."
},
"description": {
"type": "string",
"description": "The description of the collection. Only available for collections."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "The id of the parent collection. If `null` then it is the first level collection."
},
"help_center_id": {
"type": [
"integer",
"null"
],
"description": "The id of the help center the collection is in."
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute intercom_retrieve_collection --payload '{
"collection_id": "integer"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.