Get a single person or a list of people

Use this method with a unique person identifier to get a single person. Skip the identifier to return all people or use the filter parameter to return a list of people matching your specific conditions.

Please log in to see full path URL. Learn why.

get

/people/2/persons

Authorizations:

Scopes:

people:manage

people:read

Request rate limit:

5 requests / second (per account)

Learn more

query Parameters

identifier

string

Example: identifier=370329180020364

Person ID. ID type must match the type parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request

sender

string

Example: sender=2094832040560427

Sender or application ID. sender is required for all identifier types except ID, EXTERNAL_ID, PHONE, EMAIL

type

string

Enum: "ID" "EXTERNAL_ID" "PHONE" "EMAIL" "LINE" "FACEBOOK" "TELEGRAM" "PUSH" "WEB_PUSH" "LIVE_CHAT" "VIBER_BOTS" "INSTAGRAM" "INSTAGRAM_DM" "TWITTER" "APPLE_BUSINESS_CHAT" "KAKAO_SANGDAM" "OPEN_CHANNEL"

Example: type=PHONE

Type of the person ID

limit

integer <int32>

Example: limit=20

Number of persons to return per page. Default - 20. Maximum - 1000.

page

integer <int32>

Example: page=1

Page of results to return. Default - 1.

includeTotalCount

boolean

Example: includeTotalCount=false

Returns total count of persons, if set to true.

orderBy

string

Example: orderBy=modifiedAt:desc

Results ordering. Possible ordering fields are firstName, lastName, createdAt and modifiedAt. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.

filter

string

Example: filter={"#and":[{"firstName":"Alex"},{"#contains": { "tags":"VIP Client"}}]}}

Allows to filter persons using simple queries. Just pass to the parameter URL encoded query.

List of supported logical operators:

Logical Operator	Description
`#and`	Joins query clauses with a logical AND returns all records that match the conditions of both clauses.
`#or`	Joins query clauses with a logical OR returns all records that match the conditions of either clause.

List of supported comparison operators:

Comparison Operator	Supported Type	Description
`#eq`	string, integer, decimal, date	Matches values that are equal to a specified value.
`#ne`	string, integer, decimal, date	Matches all values that are not equal to a specified value.
`#contains`	string	Matches the records that contain a specified value.
`#startsWith`	string	Matches the records that start with a specified value.
`#endsWith`	string	Matches the records that end with a specified value.
`#gt`	integer, decimal, date	Matches values that are greater than a specified value.
`#lt`	integer, decimal, date	Matches values that are less than a specified value.
`#gte`	integer, decimal, date	Matches values that are greater than or equal to a specified value.
`#lte`	integer, decimal, date	Matches values that are less than or equal to a specified value.

Responses

default

successful response

401

Unauthorized

403

Forbidden

429

Too Many Requests

4XX

Error responses

500

Internal Server Error

5XX

Error responses

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/people/2/persons?identifier=370329180020364&sender=2094832040560427&type=PHONE&limit=20&page=1&includeTotalCount=false&orderBy=modifiedAt%3Adesc&filter=%7B%22%23and%22%3A%5B%7B%22firstName%22%3A%22Alex%22%7D%2C%7B%22%23contains%22%3A%20%7B%20%22tags%22%3A%22VIP%20Client%22%7D%7D%5D%7D%7D' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

Copy

Collapse all


{"createdAt": "2018-03-29T13:46:31",
"modifiedAt": "2018-03-30T11:25:13",
"id": 1,
"externalId": "3",
"firstName": "Jane",
"lastName": "Smith",
"address": "67 Farringdon Road",
"city": "London",
"country": "United Kingdom",
"gender": "FEMALE",
"birthDate": "1966-01-15",
"middleName": "Janie",
"preferredLanguage": "en-gb",
"profilePicture": "http://profile.com",
"origin": "API",
"modifiedFrom": "API",
"tags": 
["VIP Customers",
"New Customers"
],
"customAttributes": 
{"Contract Expiry": "2018-06-01",
"Company": "Acme",
"ShoppingCartList": 
[
{"productName": "Sneakers",
"productPrice": 25.33,
"productCategory": "Sport Sneakers",
"productImage": "/image1.png"
},
{"productName": "T-Shirt",
"productPrice": 9.99,
"productCategory": "Casual",
"productImage": "/image2.png"
}
]
},
"contactInformation": 
{"phone": 
[
{"number": "41793026727"
}
],
"email": 
[
{"address": "janewilliams@acme.com"
}
],
"push": 
[
{"applicationId": "FDCC8516470A3AE97FB8AC218D5D0D3D",
"registrationId": "c5db0c47-465c-4e1c-abf8-7cedc275dd19",
"additionalData": 
{"birthdate": "1988-07-31",
"email": "test@test.com",
"firstName": "Jane",
"gender": "F",
"lastName": "Smith",
"middleName": "Janie"
},
"systemData": 
{"cloudType": "GCM",
"registrationEnabled": "true",
"sdkName": "MobileMessaging SDK",
"os": "Android"
}
}
],
"facebook": 
[
{"applicationId": "370329180020364",
"userId": "2094832040560427",
"systemData": 
{"gender": "female",
"lastName": "Smith",
"firstName": "Jane"
}
}
],
"line": 
[
{"applicationId": "1644264921",
"userId": "U045147f1ad961bfe996b72bbf417f3c9",
"systemData": 
{"displayName": "Jane Smith"
}
}
],
"instagram": 
[
{"applicationId": "17841446795352028",
"userId": "12461436693342628",
"systemData": 
{"displayName": "jane.smith"
}
}
],
"twitter": 
[
{"applicationId": "1148203323283877",
"userId": "370329180020364",
"systemData": 
{"displayName": "Jane Smith"
}
}
],
"appleBusinessChat": 
[
{"applicationId": "387465931",
"userId": "387465931",
"systemData": 
{"displayName": "Jane Smith"
}
}
]
}
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use