List Folders

Description

Retrieve a list of folders.

Request

HTTP Method: GET

Query Parameter Description
team_id Optional ID of team to which the folders belongs.
content_type Optional The type of content stored in the folders.
per_page Optional Set the number of results returned per page. Defaults to 20.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/folders \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON Array describing folders in the Tines tenant.

Field description

Parameter Description
id The folder ID.
name The folder name.
team_id ID of team to which the folder belongs.
content_type The type of content stored in the folder
size The number of items in this folder

Sample response

{
  "folders": [
    {
      "id": 1,
      "name": "Credential folder",
      "content_type": "CREDENTIAL",
      "team_id": 1,
      "size": 1
    },
    {
      "id": 2,
      "name": "Resource folder",
      "content_type": "RESOURCE",
      "team_id": 1,
      "size": 1
    },
    {
      "id": 3,
      "name": "Story folder",
      "content_type": "STORY",
      "team_id": 1,
      "size": 5
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/folders?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 3
  }
}
Was this helpful?