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.
skipintegerOptionalDefault:
Number of items to skip.
0
limitintegerOptionalDefault:
Maximum number of items to return.
25
sortstringOptional
Field by which to sort.
orderstring · enumOptionalPossible values:
Sort order, 'asc' or 'desc'.
Responses
200
OK
application/json
400
Bad Request
application/json
get
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"
}
Last updated
Was this helpful?