Get all folders

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

❗️

Ongoing changes for this endpoint

We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
These are non breaking changes. The default value for the attributes will be 0.

Code Examples

You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here

const SibApiV3Sdk = require('sib-api-v3-sdk'); let defaultClient = SibApiV3Sdk.ApiClient.instance; let apiKey = defaultClient.authentications['api-key']; apiKey.apiKey = 'YOUR API KEY'; let apiInstance = new SibApiV3Sdk.ContactsApi(); let limit = 10; let offset = 0; apiInstance.getFolders(limit, offset).then(function(data) { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, function(error) { console.error(error); });
<?php require_once(__DIR__ . '/vendor/autoload.php'); $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY'); $apiInstance = new SendinBlue\Client\Api\ContactsApi( new GuzzleHttp\Client(), $config ); $limit = 10; $offset = 0; try { $result = $apiInstance->getFolders($limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getFolders: ', $e->getMessage(), PHP_EOL; } ?>
from __future__ import print_function import time import sib_api_v3_sdk from sib_api_v3_sdk.rest import ApiException from pprint import pprint configuration = sib_api_v3_sdk.Configuration() configuration.api_key['api-key'] = 'YOUR API KEY' api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) limit = 10 offset = 0 try: api_response = api_instance.get_folders(limit, offset) pprint(api_response) except ApiException as e: print("Exception when calling ContactsApi->get_folders: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript'); let apiInstance = new SibApiV3Sdk.ContactsApi() let apiKey = apiInstance.authentications['apiKey']; apiKey.apiKey = 'YOUR API KEY'; let limit = 10; let offset = 0; apiInstance.getFolders(limit, offset).then(function(data) { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, function(error) { console.error(error); });
package sibApi; import sendinblue.ApiClient; import sendinblue.Configuration; import sendinblue.auth.ApiKeyAuth; import sibModel.*; public class Program { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: api-key ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key"); apiKey.setApiKey("YOUR API KEY"); try { ContactsApi api = new ContactsApi(); Long limit = 50l; Long offset = 0l; String sort = null; GetFolders response = api.getFolders(limit, offset, sort); System.out.println(response.toString()); } catch (Exception e) { System.out.println("Exception occurred:- " + e.getMessage()); } } }
using sib_api_v3_sdk.Api; using sib_api_v3_sdk.Client; using sib_api_v3_sdk.Model; using System; using System.Diagnostics; namespace Sendinblue { class Program { static void Main(string[] args) { Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY"); var apiInstance = new ContactsApi(); long? limit = 50; long? offset = 0; try { GetFolders result = apiInstance.GetFolders(limit, offset); Debug.WriteLine(result.ToJson()); Console.WriteLine(result.ToJson()); Console.ReadLine(); } catch (Exception e) { Debug.WriteLine(e.Message); Console.WriteLine(e.Message); Console.ReadLine(); } } } }
package main import ( "fmt" "context" sib_api_v3_sdk "./lib" "github.com/antihax/optional" ) func main() { var ctx context.Context var cli = sib_api_v3_sdk.APIClient{ cfg: sib_api_v3_sdk.NewConfiguration(), } //Configure API key authorization: api-key cli.cfg.AddDefaultHeader("api-key", "YOUR_API_KEY") sib := sib_api_v3_sdk.NewAPIClient(cli.cfg) limit := int64(10) offset := int64(0) params := &ContactsApiGetFoldersOpts{ Sort: optional.NewString("asc"), } obj, resp, err := sib.ContactsApi.GetFolders(ctx, limit, offset, params) if err!=nil{ fmt.Println("Error in ContactsApi->GetFolders ",err.Error()) return } fmt.Println( "GetFolders response:",resp,"GetFolders object:",obj) return }
# load the gem require 'sib-api-v3-sdk' # setup authorization SibApiV3Sdk.configure do |config| # Configure API key authorization: api-key config.api_key['api-key'] = 'YOUR API KEY' end api_instance = SibApiV3Sdk::ContactsApi.new limit = 10 # Integer | Number of documents per page offset = 0 # Integer | Index of the first document of the page opts = { sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed } begin #Get all folders result = api_instance.get_folders(limit, offset, opts) p result rescue SibApiV3Sdk::ApiError => e puts "Exception when calling ContactsApi->get_folders: #{e}" end
Query Params
int64
0 to 50
Defaults to 10

Number of documents per page

int64
Defaults to 0

Index of the first document of the page

string
Defaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json