v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0189430445.4 KB

Entities

List entities

List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities.

post/rest/api/v1/listentities

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

entityType'PEOPLE' | 'TEAMS' | 'CUSTOM_ENTITIES'

datasourcestring

The datasource associated with the entity type, most commonly used with CUSTOM_ENTITIES

querystring

A query string to search for entities that each entity in the response must conform to. An empty query does not filter any entities.

includeFieldsstring[]

List of entity fields to return (that aren't returned by default)

pageSizeinteger

Hint to the server about how many results to send back. Server may return less.

cursorstring

Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.

sourcestring

A string denoting the search surface from which the endpoint is called.

requestType'STANDARD' | 'FULL_DIRECTORY'

The type of request being made.

Example request

{
  "filter": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ],
  "pageSize": 100
}

Response

cursorstring

Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.

totalCountinteger

The total number of entities available

hasMoreResultsboolean

Whether or not more entities can be fetched.

sortOptionsEntitiesSortOrder[]

Sort options from EntitiesSortOrder supported for this response. Default is empty list.

customFacetNamesstring[]

list of Person attributes that are custom setup by deployment

Example response

{
  "results": [
    {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    }
  ],
  "teamResults": [
    {
      "members": [
        {
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          }
        }
      ],
      "customFields": [
        {
          "values": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ]
        }
      ],
      "datasourceProfiles": [
        {
          "datasource": "github"
        }
      ]
    }
  ],
  "customEntityResults": [
    {
      "roles": [
        {
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          }
        }
      ]
    }
  ],
  "facetResults": [
    {
      "sourceName": "container_name",
      "operatorName": "SelectMultiple",
      "buckets": [
        {
          "count": 1,
          "datasource": "jira",
          "percentage": 5,
          "value": {
            "stringValue": "engineering",
            "integerValue": 5,
            "displayLabel": "engineering",
            "iconConfig": {
              "color": "#343CED",
              "key": "person_icon",
              "iconType": "GLYPH",
              "name": "user"
            }
          }
        }
      ],
      "groupName": "Service Cloud"
    }
  ]
}