Skip to content
Home/
/Folders

List all folders

Request

You can fetch a list of all folders for organizing content by making a GET request to https://api.intercom.io/folders.

Requires the read_articles_scope or read_write_articles_scope OAuth scope.

Security
bearerAuth
Query
pageinteger

The page number

Example:page=1
per_pageinteger

Number of results per page

Example:per_page=50
parent_folder_idinteger

Filter folders by parent folder ID. Use this to list only direct children of a specific folder.

Example:parent_folder_id=1
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.17
curl -i -X GET \
  'https://api.intercom.io/folders?page=1&per_page=50&parent_folder_id=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.17'

Responses

successful. pages.page and pages.per_page are returned as strings when you send page and per_page in the request, and as integers otherwise.

Bodyapplication/json
typestring
Value:"list"
Example:"list"
dataArray of objects(Folder)

The folders on this page. Unlike when you retrieve a single folder, the keys description, emoji and parent_folder_id are omitted when they are null.

total_countinteger

Total number of folders

Example:2
pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

Response
{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}