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>"
const queryParams = new URLSearchParams({
page: "1",
take: "10",
orderBy: "createdAt",
orderDirection: "desc",
search: "marketing",
});
const response = await fetch(
`https://api-integration.ollang.com/integration/folder?${queryParams}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
}
);
const folders = await response.json();
console.log("Folders:", folders);
import requests
params = {
'page': 1,
'take': 10,
'orderBy': 'createdAt',
'orderDirection': 'desc',
'search': 'marketing'
}
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
'https://api-integration.ollang.com/integration/folder',
headers=headers,
params=params
)
folders = response.json()
print("Folders:", folders)
$queryParams = http_build_query([
'page' => 1,
'take' => 10,
'orderBy' => 'createdAt',
'orderDirection' => 'desc',
'search' => 'marketing'
]);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/folder?' . $queryParams,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
$folders = json_decode($response, true);
curl_close($curl);
echo "Folders: " . json_encode($folders);
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL := "https://api-integration.ollang.com/integration/folder"
params := url.Values{}
params.Add("page", "1")
params.Add("take", "10")
params.Add("orderBy", "createdAt")
params.Add("orderDirection", "desc")
params.Add("search", "marketing")
fullURL := baseURL + "?" + params.Encode()
req, _ := http.NewRequest("GET", fullURL, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var folders map[string]interface{}
json.Unmarshal(body, &folders)
fmt.Println("Folders:", folders)
}
String baseUrl = "https://api-integration.ollang.com/integration/folder";
String queryParams = "?page=1&take=10&orderBy=createdAt&orderDirection=desc&search=marketing";
HttpResponse<String> response = Unirest.get(baseUrl + queryParams)
.header("X-Api-Key", "<your-api-key>")
.asString();
JSONObject folders = new JSONObject(response.getBody());
System.out.println("Folders: " + folders.toString());
{
"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
}
}
{
"error": "Invalid query parameters",
"message": "The 'take' parameter must be between 1 and 50",
"code": "INVALID_PAGINATION"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"error": "Internal server error",
"message": "An unexpected error occurred while retrieving folders",
"code": "INTERNAL_ERROR"
}
Ollang API Reference
Retrieve All Folders
Get a paginated list of all folders with optional search and sorting functionality
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>"
const queryParams = new URLSearchParams({
page: "1",
take: "10",
orderBy: "createdAt",
orderDirection: "desc",
search: "marketing",
});
const response = await fetch(
`https://api-integration.ollang.com/integration/folder?${queryParams}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
}
);
const folders = await response.json();
console.log("Folders:", folders);
import requests
params = {
'page': 1,
'take': 10,
'orderBy': 'createdAt',
'orderDirection': 'desc',
'search': 'marketing'
}
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
'https://api-integration.ollang.com/integration/folder',
headers=headers,
params=params
)
folders = response.json()
print("Folders:", folders)
$queryParams = http_build_query([
'page' => 1,
'take' => 10,
'orderBy' => 'createdAt',
'orderDirection' => 'desc',
'search' => 'marketing'
]);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/folder?' . $queryParams,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
$folders = json_decode($response, true);
curl_close($curl);
echo "Folders: " . json_encode($folders);
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL := "https://api-integration.ollang.com/integration/folder"
params := url.Values{}
params.Add("page", "1")
params.Add("take", "10")
params.Add("orderBy", "createdAt")
params.Add("orderDirection", "desc")
params.Add("search", "marketing")
fullURL := baseURL + "?" + params.Encode()
req, _ := http.NewRequest("GET", fullURL, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var folders map[string]interface{}
json.Unmarshal(body, &folders)
fmt.Println("Folders:", folders)
}
String baseUrl = "https://api-integration.ollang.com/integration/folder";
String queryParams = "?page=1&take=10&orderBy=createdAt&orderDirection=desc&search=marketing";
HttpResponse<String> response = Unirest.get(baseUrl + queryParams)
.header("X-Api-Key", "<your-api-key>")
.asString();
JSONObject folders = new JSONObject(response.getBody());
System.out.println("Folders: " + folders.toString());
{
"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
}
}
{
"error": "Invalid query parameters",
"message": "The 'take' parameter must be between 1 and 50",
"code": "INVALID_PAGINATION"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"error": "Internal server error",
"message": "An unexpected error occurred while retrieving folders",
"code": "INTERNAL_ERROR"
}
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>"
const queryParams = new URLSearchParams({
page: "1",
take: "10",
orderBy: "createdAt",
orderDirection: "desc",
search: "marketing",
});
const response = await fetch(
`https://api-integration.ollang.com/integration/folder?${queryParams}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
}
);
const folders = await response.json();
console.log("Folders:", folders);
import requests
params = {
'page': 1,
'take': 10,
'orderBy': 'createdAt',
'orderDirection': 'desc',
'search': 'marketing'
}
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
'https://api-integration.ollang.com/integration/folder',
headers=headers,
params=params
)
folders = response.json()
print("Folders:", folders)
$queryParams = http_build_query([
'page' => 1,
'take' => 10,
'orderBy' => 'createdAt',
'orderDirection' => 'desc',
'search' => 'marketing'
]);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/folder?' . $queryParams,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
$folders = json_decode($response, true);
curl_close($curl);
echo "Folders: " . json_encode($folders);
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL := "https://api-integration.ollang.com/integration/folder"
params := url.Values{}
params.Add("page", "1")
params.Add("take", "10")
params.Add("orderBy", "createdAt")
params.Add("orderDirection", "desc")
params.Add("search", "marketing")
fullURL := baseURL + "?" + params.Encode()
req, _ := http.NewRequest("GET", fullURL, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var folders map[string]interface{}
json.Unmarshal(body, &folders)
fmt.Println("Folders:", folders)
}
String baseUrl = "https://api-integration.ollang.com/integration/folder";
String queryParams = "?page=1&take=10&orderBy=createdAt&orderDirection=desc&search=marketing";
HttpResponse<String> response = Unirest.get(baseUrl + queryParams)
.header("X-Api-Key", "<your-api-key>")
.asString();
JSONObject folders = new JSONObject(response.getBody());
System.out.println("Folders: " + folders.toString());
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
Query Parameters
number
default:"1"
The page number to retrieve. Must be a positive integer starting from 1.
number
default:"10"
The number of items per page. Must be between 1 and 50.
string
default:"id"
The field to sort the results by. Common values include
id, name,
createdAt.string
default:"desc"
The direction to sort the results. Must be either
asc (ascending) or desc
(descending).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.array
Array of folder objects containing detailed information about each folder.
Show Folder Object Properties
Show Folder Object Properties
string
Unique identifier of the folder. Use this ID when uploading files to place
projects into this folder.
string
Name of the folder.
string
Hex color code associated with the folder for visual identification (e.g., “#B6B6B6”).
string
Type of the folder. Common values include
default and api.string
The date and time when the folder was created in ISO 8601 format.
number
The number of projects contained in this folder.
object
Pagination metadata providing information about the current page and total results.
Show Pagination Metadata
Show Pagination Metadata
number
The current page number of the pagination.
number
The number of items per page.
number
The total number of items across all pages.
number
The total number of pages available.
boolean
Boolean flag indicating if there is a previous page relative to the current page.
boolean
Boolean flag indicating if there is a next page relative to the current page.
{
"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
}
}
{
"error": "Invalid query parameters",
"message": "The 'take' parameter must be between 1 and 50",
"code": "INVALID_PAGINATION"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"error": "Internal server error",
"message": "An unexpected error occurred while retrieving folders",
"code": "INTERNAL_ERROR"
}
Was this page helpful?
⌘I