Get Entities | Boosted.ai

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).

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

entity_mapmap from strings to objects

external_entity_mapmap from strings to objects

messagestring

successboolean

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

1	curl -X POST https://sandbox.api.boosted.ai/v2/account-management/entity/batch-get \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"entity_type": "user",
6	"return_type": "id_map"
7	}'

1	{
2	"entity_map": {},
3	"external_entity_map": {},
4	"message": "string",
5	"success": true
6	}