Get contacts in a list

Log in to see full request history

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 listId = 1; let opts = { 'modifiedSince': new Date("2021-01-01T19:20:30+01:00"), 'limit': 50, 'offset': 0 }; apiInstance.getContactsFromList(listId, opts).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 ); $listId = 1; $modifiedSince = new \DateTime("2021-10-20T19:20:30+01:00"); $limit = 50; $offset = 0; try { $result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContactsFromList: ', $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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) list_id = 2 modified_since = '2020-01-20T19:20:30+01:00' limit = 50 offset = 0 try: api_response = api_instance.get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset) pprint(api_response) except ApiException as e: print("Exception when calling ListsApi->get_contacts_from_list: %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 listId = 2; let modifiedSince = new Date("2021-01-01T19:20:30+01:00"); let limit = 50; let offset = 0; apiInstance.getContactsFromList(listId, modifiedSince, 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.*; import org.threeten.bp.OffsetDateTime; 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 listId = 2l; OffsetDateTime modifiedSince = OffsetDateTime.parse("2020-01-26T15:10:00+05:30"); Long limit = 50l; Long offset = 0l; String sort = null; GetContacts response = api.getContactsFromList(listId, modifiedSince, 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? listId = 2; DateTime? modifiedSince = DateTime.Parse("2020-10-20T19:20:30+05:30"); long? limit = 50; long? offset = 0; try { GetContacts result = apiInstance.GetContactsFromList(listId, modifiedSince, 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) listId := int64(2) body := &ContactsApiGetContactsFromListOpts{ Limit: optional.NewInt64(10), Offset: optional.NewInt64(0), ModifiedSince: optional.NewString("2020-01-20T19:20:30+01:00"), Sort: optional.NewString("asc"), } obj, resp, err := sib.ContactsApi.GetContactsFromList(ctx, listId, body) if err!=nil{ fmt.Println("Error in ContactsApi->GetContactsFromList ",err.Error()) return } fmt.Println( "GetContactsFromList response:",resp,"GetContactsFromList 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 list_id = 789 # Integer | Id of the list opts = { modified_since: DateTime.iso8601('2021-02-03T04:05:06+07:00'), # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. limit: 50, # Integer | Number of documents per page offset: 0, # Integer | Index of the first document of the page 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 contacts in a list result = api_instance.get_contacts_from_list(list_id, opts) p result rescue SibApiV3Sdk::ApiError => e puts "Exception when calling ContactsApi->get_contacts_from_list: #{e}" end
Path Params
int64
required

Id of the list

Query Params
string

Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

int64
0 to 500
Defaults to 50

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