Skip to main content
GET
/
integration
/
folder
curl -X GET "https://api-integration.ollang.com/integration/folder?page=1&take=10&orderBy=createdAt&orderDirection=desc&search=marketing" \
  -H "X-Api-Key: <your-api-key>"

{
  "data": [
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e2",
      "name": "Marketing Videos",
      "hexColor": "#6148f9",
      "type": "default",
      "createdAt": "2024-01-10T08:15:30.511Z",
      "projectCount": 12
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e5",
      "name": "API Uploads",
      "hexColor": "#B6B6B6",
      "type": "api",
      "createdAt": "2024-01-05T14:22:10.211Z",
      "projectCount": 45
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e7",
      "name": "Training Materials",
      "hexColor": "#34D399",
      "type": "default",
      "createdAt": "2024-01-03T11:45:22.847Z",
      "projectCount": 8
    }
  ],
  "meta": {
    "page": 1,
    "take": 10,
    "itemCount": 3,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}
Retrieve a paginated list of all folders associated with your account. Folders are used to organize your projects. You can use folder IDs when uploading files to place projects into specific folders. 
curl -X GET "https://api-integration.ollang.com/integration/folder?page=1&take=10&orderBy=createdAt&orderDirection=desc&search=marketing" \
  -H "X-Api-Key: <your-api-key>"

​
Authorizations

This endpoint requires API key authentication. Include your API key in the request header:
  • Header name: X-Api-Key
  • Header value: Your API key from the Ollang dashboard
  • Format: X-Api-Key: your-api-key-here
You can obtain your API key from your Ollang dashboard.

​
Query Parameters

​
page
number
default:"1"
The page number to retrieve. Must be a positive integer starting from 1.
​
take
number
default:"10"
The number of items per page. Must be between 1 and 50.
​
orderBy
string
default:"id"
The field to sort the results by. Common values include id, name, createdAt.
​
orderDirection
string
default:"desc"
The direction to sort the results. Must be either asc (ascending) or desc (descending).
​
search
string
A search term to filter folders by name. The search is case-insensitive and supports partial matches.

​
Response

The response contains a paginated list of folders with metadata about the pagination.
​
data
array
Array of folder objects containing detailed information about each folder.
​
meta
object
Pagination metadata providing information about the current page and total results.
{
  "data": [
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e2",
      "name": "Marketing Videos",
      "hexColor": "#6148f9",
      "type": "default",
      "createdAt": "2024-01-10T08:15:30.511Z",
      "projectCount": 12
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e5",
      "name": "API Uploads",
      "hexColor": "#B6B6B6",
      "type": "api",
      "createdAt": "2024-01-05T14:22:10.211Z",
      "projectCount": 45
    },
    {
      "id": "60b8d6f1e1b9b1d8c6c0d8e7",
      "name": "Training Materials",
      "hexColor": "#34D399",
      "type": "default",
      "createdAt": "2024-01-03T11:45:22.847Z",
      "projectCount": 8
    }
  ],
  "meta": {
    "page": 1,
    "take": 10,
    "itemCount": 3,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}