Get profiles for a segment

Learn more about the Segments Api to retrieve profiles part of a segment.

Use the Segments to retrieve the profiles that belong to a segment.

HTTP method and endpoint

Use the following HTTP method and endpoint path to retrieve the profiles in a segment.

GET {platformUrl}/segments/{id}/entities

Replace {platformUrl} with your Reltio platform base URL.

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`id`	String	Yes	Unique identifier of the segment. Example: `3prE0YZ`

Query parameters

The following table describes the query parameters and their values.


Parameter	Type	Required	Description	Accepted values / Default
`sort`	String	No	The field used to sort the results.	Not stated in source.
`order`	String	No	Indicates whether the profiles are sorted in ascending or descending order.	Not stated in source.
`filter`	String	No	Search API filter conditions against the segment fields. Use Reltio QL syntax.	Not stated in source.
`offset`	Integer	No	The pagination offset.	Not stated in source.
`max`	Integer	No	The maximum number of results to return.	Not stated in source.
`returnPartialResults`	Boolean	No	When set to `true` and the segment's `status` is `submitted` or `in_progress`, the response returns the data that currently exists for the segment instead of returning the `SEGMENT_NOT_EVALUATED` error. When set to `false` or omitted, the response returns profiles only after the segment has finished evaluating.	`true`, `false`; Default: `false`

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer `<access_token>`	Yes
`Content-Type`	application/json	Yes

Request body

This operation does not require a request body.

Example request

Use the following example to retrieve the profiles in a segment. Replace the sample values with values from your environment.

GET {platformUrl}/segments/3prE0YZ/entities

Response body

The following table describes the fields returned for each profile object in the response array.


Field	Type	Description
`uri`	String	Unique URI of the profile.
`type`	String	Entity type of the profile.
`createdBy`	String	Identifier of the user or service that created the profile.
`createdTime`	Long	Timestamp, in epoch milliseconds, when the profile was created.
`updatedBy`	String	Identifier of the user or service that last updated the profile.
`updatedTime`	Long	Timestamp, in epoch milliseconds, when the profile was last updated.
`attributes`	Object	The profile's attribute values.
`isFavorite`	Boolean	Indicates whether the profile is marked as a favorite.
`crosswalks`	Array	The source system crosswalk records associated with the profile.
`analyticsAttributes`	Object	Computed analytics attribute values for the profile.
`tags`	Array of String	Tags applied to the profile.
`label`	String	Display label for the profile.
`secondaryLabel`	String	Secondary display label for the profile.

Example response

The following example shows a response containing an array of profile objects.

[
    {
        "uri": "entities/03CHaga",
        "type": "configuration/entityTypes/Organization",
        "createdBy": "solutionconsulting.serviceuser",
        "createdTime": 1729784968264,
        "updatedBy": "TQdhoABqN1DqSgj",
        "updatedTime": 1740974441362,
        "attributes": {},
        "isFavorite": false,
        "crosswalks": [],
        "analyticsAttributes": {},
        "tags": ["Demo Data"],
        "label": "Trammell Crow Company",
        "secondaryLabel": ""
    }
]

Error codes and recommended actions

The following table lists the possible error responses returned by this API.


HTTP status	Error code	Description	Recommended action
`400 Bad Request`	`32006`	The segment has not finished evaluating and `returnPartialResults` was not set to `true`.	Wait for the segment to finish evaluating and retry the request, or resend the request with `returnPartialResults` set to `true` to receive the data that currently exists.

Unify and manage your data