---
title: "Get persons in a segment"
method: GET
path: "/people/3/segments/{segmentId}/persons"
tags: ["customer-engagement", "people", "segments"]
---

# Get persons in a segment

`GET /people/3/segments/{segmentId}/persons`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/people/3/segments/{segmentId}/persons`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

Use this method to get persons in a segment by ID.

## Path parameters

- `segmentId` integer, required: A unique segment identifier.

## Query parameters

- `page` integer
- `size` integer
- `sort` string[]

## Response `200`

OK

- D76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91cPagePersonV3
  - `results` D76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91cPersonV3[], required: The list of the results for this page.
    - `id` integer: Unique id of the entity.
    - `externalId` string: Unique ID for a person from your or another external system, 256 characters max.
    - `type` 'CUSTOMER' | 'LEAD': Person's type, default type is CUSTOMER.
    - `firstName` string: Person's first name, 255 characters max.
    - `middleName` string: Person's middle name, 50 characters max.
    - `lastName` string: Person's last name, 255 characters max.
    - `nickName` string: Person's nick name, 50 characters max.
    - `country` string: Person's country, 50 characters max.
    - `city` string: Person's city, 50 characters max.
    - `address` string: Person's address, 256 characters max.
    - `gender` 'MALE' | 'FEMALE': Person's gender.
    - `preferredLanguage` string: Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.
    - `birthDate` string, date: Person's date of birth, format `YYYY-MM-DD`.
    - `profilePicture` string, url: URL for the person's profile picture, 2083 characters max.
    - `tags` string[]: List of tags that this person has.
    - `contactInformation` D76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91cContactInformationV3[]: List of phones, emails and other information how a person can be contacted.
      - `type` 'PHONE' | 'EMAIL' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'PUSH' | 'WEB_PUSH' | 'LIVE_CHAT' | 'VIBER_BOTS' | 'INSTAGRAM' | 'TWITTER' | 'INSTAGRAM_DM' | 'KAKAO_SANGDAM' | 'APPLE_BUSINESS_CHAT' | 'OPEN_CHANNEL' | 'ZALO_FOLLOWER' | 'TIKTOK_BM' | 'WHATSAPP' | 'KAKAO_TALK', required: Type of the person ID
      - `identifier` string, required: 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. 255 characters max.
      - `sender` string: Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.
      - `primary` boolean: Indicates if this ID is preferred for communication.
    - `customAttributes` object: List of custom attributes for the person, 4096 characters max per value.
    - `computedAttributes` object: Person's computed attributes grouped by type.
    - `createdFrom` 'API' | 'PORTAL' | 'WEB_SDK' | 'INTEGRATION' | 'PUSH' | 'FACEBOOK' | 'LINE' | 'TELEGRAM' | 'SALESFORCE' | 'DYNAMICS' | 'ZAPIER' | 'FORMS' | 'AMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS' | 'IMPORT' | 'INSTAGRAM_DM' | 'FLOW' | 'LIVE_CHAT' | 'VKONTAKTE' | 'ZALO_FOLLOWER' | 'TIKTOK_BM' | 'WHATSAPP' | 'KAKAO_TALK' | 'UNKNOWN': Source system that last modified this person record.
    - `createdBy` string: Identifier of the user who created this person record.
    - `createdAt` string, date-time: Date and time of creation. 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' | 'AMS' | 'COMPUTED' | 'ANSWERS' | 'CONVERSATIONS' | 'IMPORT' | 'INSTAGRAM_DM' | 'FLOW' | 'LIVE_CHAT' | 'VKONTAKTE' | 'ZALO_FOLLOWER' | 'TIKTOK_BM' | 'WHATSAPP' | 'KAKAO_TALK' | 'UNKNOWN': Source system that last modified this person record.
    - `modifiedBy` string: Identifier of the user who last modified this person record.
    - `modifiedAt` string, date-time: Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.
  - `paging` D76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91cPageInfo, required: Contains information about the page.
    - `page` integer, required: Requested page number.
    - `size` integer, required: Requested page size.
    - `totalPages` integer, required: The total number of pages of the results matching the requested parameters.
    - `totalResults` integer, required: The total number of the results matching the requested parameters.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)