List

To list the existing folders you need to execute a GET request against the /libraries/:id/folders endpoint.

Since potentially there could be thousands of folders, pagination is supported with limit, order and after arguments. Read about pagination to learn the details of it. By default maximum 100 folders will be returned in the response.

If you want to retrieve the details of one concrete folder execute a GET request against the /libraries/:libraryId/folders/:folderId endpoint

Request (listing all folders)

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/libraries/45d125d8-bac9-43a5-a6a8-311a5433239d/folders \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

import com.fasterxml.jackson.databind.ObjectMapper;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.Base64;
import java.util.Map;

String TEAM_ID = "YOUR_TEAM_ID";
String DEVELOPER_KEY = "YOUR_DEVELOPER_KEY";
String authorizationHeader = "Bearer " + Base64.getEncoder().encodeToString((TEAM_ID + ":" + DEVELOPER_KEY).getBytes());

//Put your library id here - this value is just an example
String libraryId = "45d125d8-bac9-43a5-a6a8-311a5433239d";

HttpRequest request = HttpRequest.newBuilder()
  .GET()
  .uri(new URI("https://api.digitalsamba.com/api/v1/libraries/" + libraryId + "/folders"))
  .header("Authorization", authorizationHeader)
  .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, BodyHandlers.ofString());

System.out.println("Status code: " + response.statusCode());
System.out.println("Body: " + response.body());

Response (200 OK)

{
    "total_count": 6124,
    "data": [
        {
            "id": "1fc95d41-5358-4a81-adb4-5cd8c12e8308",
            "name": "Birthday Party",
            "parent_id": null,
            "source": "api",
            "created_at": "2024-10-08T08:05:51Z"
        },
        ...............99 more folders...............
    ]
}

The total_count is the total amount of folders you have in the library. It is NOT the amount of folders in the current page returned in the data array. In the above example you have 6124 folders in total, but in the data array there will be maximum 100 folders (the default limit argument value).

Request (get a concrete folder)

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/libraries/45d125d8-bac9-43a5-a6a8-311a5433239d/folders/1fc95d41-5358-4a81-adb4-5cd8c12e8308 \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

import com.fasterxml.jackson.databind.ObjectMapper;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.Base64;
import java.util.Map;

String TEAM_ID = "YOUR_TEAM_ID";
String DEVELOPER_KEY = "YOUR_DEVELOPER_KEY";
String authorizationHeader = "Bearer " + Base64.getEncoder().encodeToString((TEAM_ID + ":" + DEVELOPER_KEY).getBytes());

//Put your library id here - this value is just an example
String libraryId = "ec463c74-b227-4bec-9c95-b3eb515b6548";

//Put your folder id here - this value is just an example
String folderId = "1fc95d41-5358-4a81-adb4-5cd8c12e8308";

HttpRequest request = HttpRequest.newBuilder()
  .GET()
  .uri(new URI("https://api.digitalsamba.com/api/v1/libraries/" + libraryId + "/folders/" + folderId))
  .header("Authorization", authorizationHeader)
  .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, BodyHandlers.ofString());

System.out.println("Status code: " + response.statusCode());
System.out.println("Body: " + response.body());

Response (200 OK)

{
    "id": "1fc95d41-5358-4a81-adb4-5cd8c12e8308",
    "name": "Birthday Party",
    "parent_id": null,
    "source": "api",
    "created_at": "2024-10-08T08:05:51Z"
}

PreviousEdit NextDelete

Last updated 1 year ago