Liste des utilisateurs

Get /users

Paramètres :

Aucun

Réponse :

Noeud d'utilisateurs :

Nom

Description

Type

Id utilisateur

String

username

Adresse email de l'utilisateur

String

civility

1 : M ; 2 : Mme

Int

firstName

Prénom

String

lastName

Nom

String

customerType

0 : particulier ; 1 : professionnel

String

company

Société

String

activity

Secteur d'activité

String

job

Poste

String

address

Adresse

String

address2

Adresse (suite)

String

zipCode

Code postal

String

city

Ville

String

country

Pays

String

phone

Téléphone

String

mobile

Téléphone mobile

String

settings

Paramètres du compte utilisateur

Nom	Description	Type
newsletter	Si l'utilisateur est inscrit à la newsletter	Boolean
language	Langage de l'interface	String
dateFormat	Date au format timestamp	String
timeFormat		String
timezone		String

Array

Langage de programmation :

Exemple de réponse :

							[
								{
									"id": "5565re4gre4ht6h54tgregre",
									"username": "email1@example.com",
									"civility": 1,
									"firstName": "Firstname1",
									"lastName": "Lastname1",
									"customerType": 1,
									"company": "Company1",
									"activity": "Activity1",
									"job": "Job1",
									"address": "Address1",
									"address2": "Address11",
									"zipCode": "Zipcode1",
									"city": "City1",
									"country": "Country1",
									"phone": "00-00-00-00-01",
									"mobile": "00-00-00-00-11",
									"settings": {
										"newsletter": true,
										"language": "EN",
										"dateFormat": "MM/DD/YYYY",
										"timeFormat": "HH:mm:ss",
										"timezone": "Europe/Paris"
									}
								},
								{
									"id": "5565re4gre4ht6h54tgregre",
									"username": "email2@example.com",
									"civility": 2,
									"firstName": "Firstname2",
									"lastName": "Lastname2",
									"customerType": 2,
									"company": "Company2",
									"activity": "Activity2",
									"job": "Job2",
									"address": "Address2",
									"address2": "Address22",
									"zipCode": "Zipcode2",
									"city": "City2",
									"country": "Country2",
									"phone": "00-00-00-00-02",
									"mobile": "00-00-00-00-22",
									"settings": {
										"newsletter": true,
										"language": "EN",
										"dateFormat": "MM/DD/YYYY",
										"timeFormat": "HH:mm:ss",
										"timezone": "Europe/Paris"
									}
								}
							]

Exemple de code :

								curl -X GET -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/users

require 'vendor/autoload.php';

$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');

try {
	
	$result = $tipimail->getUsersService()->getAll();
	var_dump($result);
		
}
catch(Tipimail\Exceptions\TipimailException $e) {
	echo 'Exception received :', $e->getMessage(), "\n";
	
}