Directory API

The Directory API is designed to manage individual people records within a division. It provides endpoints to create, retrieve, update, and delete people.

get

Retrieve a list of people or a specific person by ID.

Authorizations

Query parameters

people_idstringOptional

Optional ID of the person to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

Responses

get

HTTPcURLJavaScriptPython

GET /directory/v1/people HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "people": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_people_successful"
}