Skip to main content
POST
Get Profiles

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Given a set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.

Given a set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.

Entities
object[]
required

Entity keys of the profiles to load. Must be between 1 and 25

IncludeStatistics
boolean
required

Determines whether the entity statistics will be returned in the entity profile. Default is false.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

DataAsObject
boolean

Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026