Get Entities

This method allows customers to fetch the information Boosted has about entities, or their mapping. EntityType and ReturnType must be specified. They indicate what entities one wants to get information for (e.g., USER, WORKSPACE, or ORG), and what information the user wants back (e.g., ID_MAP, or the full ENTITY).

Authentication

Authorizationstring

Enter your JWT Token here in the format: Bearer {token}

Request

Entity BatchGet Request
entity_typeenumRequired
Allowed values:
return_typeenumRequired
Allowed values:
all_idsbooleanOptional
external_idslist of stringsOptional
idslist of stringsOptional

Response

OK
entity_mapmap from strings to objects or null
external_entity_mapmap from strings to objects or null
messagestring or null
successboolean or null

Errors