User API \ List all users PHP SDK

Resource/URI GET POST PUT DELETE
Users /users.json List all users – Import access token –
User /users/<user_token>.json Retrieve user details – – Delete user
User /users/<user_token>/contacts.json Read contacts – – –
User /users/<user_token>/publish.json – Publish on social networks – –

Workflow

Request: the code to send to the API

Send an API request to this endpoint in order to obtain the list of your users :

GET /users.json

The following fields may optionally be used to the filter the resultset.

Field Supported Operators
date_creation
string, eg. 14 Jan 2020 12:13 		gt, lt
date_last_login
string, eg. 14 Jan 2020 12:13 		gt, lt

Result: the code returned by the API

The API will either return a HTTP status code 200 on success or an appropriate message body with further details on the error that occured. Requests that return multiple entries will be paginated to 250 items by default. Individual user records can be retrieved using this endpoint.

Response Example

	{
		"response": {
			"request": {
			"date": "Tue, 13 Sep 2011 10:31:46 0200",
				"resource": "/users.json",
				"status": {
					"flag": "success",
					"code": 200,
					"info": "Your request has been processed successfully"	
				}
			},
			"result": {
				"data": {
					"users": {
					 	"pagination": {      
							"current_page": 1,
							"total_pages": 1,
							"entries_per_page": 250,
							"total_entries": 2,
							"order": {
								"field": "date_creation",
								"direction": "asc"
	             }
	           },
						"count": 2,
						"entries": [
							{
								"user_token": "247db8ab-0af5-4a01-8dd1-a9454d76c23e",
								"date_creation": "Wed, 14 Jan 2011 12:13:00  0200",
								"date_last_login": "Wed, 24 Aug 2011 17:23:00  0200",
								"num_logins": 148,
								"identities": [
									{
										"identity_token": "34d2fe86-31dc-4686-bce0-96aabd5febeb",
										"provider": "facebook"
									},
									{
										"identity_token": "1232fe86-abcc-4122-b220-aaaabd5feffa",
										"provider": "twitter"
									},								
								]		
							},						
							{						
								"user_token": "2b1c1cbe-8af2-420b-a22d-acb3b752496b",
								"date_creation": "Tue, 02 Mar 2011 23:19:47  0200",
								"date_last_login": "Tue, 02 Aug 2011 13:14:47  0200",
								"num_logins": 5,
								"identities": [
									{
										"identity_token": "aa32fe86-bbff-ffaa-1122-96aabd5febeb",
										"provider": "linkedin"
									}											
								]	
							}						
						]
					}
				}
			}
		}
	}

User Contributed Notes