INinfobip
customer-engagement
people
person-profile

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.

get/people/2/persons

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or API key in header Authorization
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Query parameters

identifierstring

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

senderstring

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

type'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' | 'ZALO_FOLLOWER' | 'TIKTOK_BM' | 'WHATSAPP' | 'KAKAO_TALK'

Type of the person ID

limitinteger

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

pageinteger

Page of results to return. Default - 1.

includeTotalCountboolean

Returns total count of persons, if set to true.

orderBystring

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.

filterstring

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

List of supported logical operators:
<table> <thead> <th>Logical Operator</th><th>Description</th> </thead> <tr> <td><code>#and</code></td><td>Joins query clauses with a logical AND returns all records that match the conditions of both clauses.</td> </tr> <tr> <td><code>#or</code></td><td>Joins query clauses with a logical OR returns all records that match the conditions of either clause.</td> </tr> </table>
List of supported comparison operators:
<table> <thead> <th>Comparison Operator</th><th>Supported Type</th><th>Description</th> </thead> <tr> <td><code>#eq</code></td><td>string, integer, decimal, date</td><td>Matches values that are equal to a specified value.</td> </tr> <tr> <td><code>#ne</code></td><td>string, integer, decimal, date</td><td>Matches all values that are not equal to a specified value.</td> </tr> <tr> <td><code>#contains</code></td><td>string</td><td>Matches the records that contain the specified value.</td> </tr> <tr> <td><code>#notContain</code></td><td>string</td><td>Matches the records that does not contain the specified value.</td> </tr> <tr> <td><code>#startsWith</code></td><td>string</td><td>Matches the records that start with a specified value.</td> </tr> <tr> <td><code>#endsWith</code></td><td>string</td><td>Matches the records that end with a specified value.</td> </tr> <tr> <td><code>#gt</code></td><td>integer, decimal, date</td><td>Matches values that are greater than a specified value.</td> </tr> <tr> <td><code>#lt</code></td><td>integer, decimal, date</td><td>Matches values that are less than a specified value.</td> </tr> <tr> <td><code>#gte</code></td><td>integer, decimal, date</td><td>Matches values that are greater than or equal to a specified value.</td> </tr> <tr> <td><code>#lte</code></td><td>integer, decimal, date</td><td>Matches values that are less than or equal to a specified value.</td> </tr> </table>

Response

successful response

addressstring

Person's address, 256 characters max.

birthDatestring

Person's date of birth, format YYYY-MM-DD.

citystring

Person's city, 50 characters max.

computedAttributesobject

Person's computed attributes grouped by type.

countrystring

Person's country, 50 characters max.

createdAtstring

Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.

customAttributesobject

List of custom attributes for the person, 4096 characters max per value.

externalIdstring

Unique ID for a person from your or another external system, 256 characters max.

firstNamestring

Person's first name, 255 characters max.

gender'MALE' | 'FEMALE'
idinteger

Unique id of the entity.

lastNamestring

Person's last name, 255 characters max.

middleNamestring

Person's middle name, 50 characters max.

modifiedAtstring

Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.

modifiedFrom'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS'
origin'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS'
preferredLanguagestring

Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.

profilePicturestring

URL for the person's profile picture, 2083 characters max.

tagsstring[]

List of tags that this person has.

type'CUSTOMER' | 'LEAD'

Changes

No recorded changes to this operation across all 1 revision of this API.