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_idstring

Optional ID of the person to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/directory/v1/people' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

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

OK