Skip to main content
Manage entities for the current session and active profile.

​
Get My Entities

Retrieve all possible entities for the current logged-in user and active profile.

​
Endpoint

GET /apirest.php/getMyEntities/

​
Headers

​
Content-Type
string
required
Must be application/json
​
Session-Token
string
required
Session token provided by the initSession endpoint
​
App-Token
string
Authorization string provided by the GLPI API configuration

​
Query Parameters

​
is_recursive
boolean
default:"false"
Also display sub-entities of the active entity

​
Response

​
myentities
array
required
Array of all user entities

​
Example

curl -X GET \
  -H 'Content-Type: application/json' \
  -H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
  -H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
  'http://path/to/glpi/apirest.php/getMyEntities'
Response: 
{
  "myentities": [
    {
      "id": 71,
      "name": "my_entity"
    }
  ]
}

​
Get Active Entities

Retrieve the active entities of the current logged-in user.

​
Endpoint

GET /apirest.php/getActiveEntities/

​
Headers

​
Content-Type
string
required
Must be application/json
​
Session-Token
string
required
Session token provided by the initSession endpoint
​
App-Token
string
Authorization string provided by the GLPI API configuration

​
Response

​
active_entity
object
required
Current active entity information

​
Example

curl -X GET \
  -H 'Content-Type: application/json' \
  -H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
  -H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
  'http://path/to/glpi/apirest.php/getActiveEntities'
Response: 
{
  "active_entity": {
    "id": 1,
    "active_entity_recursive": true,
    "active_entities": [
      {"id": 1},
      {"id": 71}
    ]
  }
}

​
Change Active Entities

Change the active entity and optionally enable recursive mode.

​
Endpoint

POST /apirest.php/changeActiveEntities/

​
Headers

​
Content-Type
string
required
Must be application/json
​
Session-Token
string
required
Session token provided by the initSession endpoint
​
App-Token
string
Authorization string provided by the GLPI API configuration

​
JSON Payload

​
entities_id
integer|string
default:"all"
ID of the new active entity. Use "all" to load all possible entities. Use getMyEntities to get available entity IDs.
​
is_recursive
boolean
default:"false"
Also display sub-entities of the active entity

​
Response

Returns an empty response body on success.

​
Example

curl -X POST \
  -H 'Content-Type: application/json' \
  -H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
  -H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
  -d '{"entities_id": 1, "is_recursive": true}' \
  'http://path/to/glpi/apirest.php/changeActiveEntities'
Response: 
200 OK

​
Status Codes

  • 200 OK - Entity changed successfully
  • 400 Bad Request - Error in input parameters

​
Notes

  • This endpoint has write access to the session
  • Only entities returned by getMyEntities can be set as active
  • The is_recursive parameter determines whether sub-entities are included in the active scope
  • Setting entities_id to "all" activates all available entities
  • Changing the active entity affects which resources are accessible in subsequent API calls

Build docs developers (and LLMs) love

Get started for freeTalk to us