gospace AIDocsAdmin Console

Directory API

get

Retrieve a list of people or a specific person by ID, with optional filters for email, first name, last name, or external ID.

Authorizations
Query parameters
people_idstringOptional

Optional ID of the person to retrieve.

emailstringOptional

Optional email to filter people.

first_namestringOptional

Optional first name to filter people.

last_namestringOptional

Optional last name to filter people.

external_idstringOptional

Optional external ID to filter people.

skipintegerOptional

Number of items to skip for pagination.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field to sort by (e.g., email, first_name, last_name, external_id).

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
Responses
200

OK

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": [
      {
        "people_id": "text",
        "email": "text",
        "first_name": "text",
        "last_name": "text",
        "external_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 1
      },
      "total_results": 1
    }
  },
  "identifier": "text"
}
post

Create multiple new people in a single request.

Authorizations
Body
Responses
200

Created

application/json
post
POST /directory/v1/people HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "people": [
    {
      "email": "text",
      "first_name": "text",
      "last_name": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "people": [
      {
        "people_id": "text",
        "email": "text",
        "first_name": "text",
        "last_name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
put

Update multiple existing people by their IDs.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /directory/v1/people HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "people": [
    {
      "people_id": "text",
      "email": "text",
      "first_name": "text",
      "last_name": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "people": [
      {
        "people_id": "text",
        "email": "text",
        "first_name": "text",
        "last_name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
delete

Delete multiple people by their IDs.

Authorizations
Body
Responses
200

OK

application/json
delete
DELETE /directory/v1/people HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "people": [
    {
      "people_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "people": [
      {
        "people_id": "text"
      }
    ]
  },
  "identifier": "text"
}
get

Retrieve a list of teams or a specific team by ID, with optional filters for team name or external ID.

Authorizations
Query parameters
team_idstringOptional

Optional ID of the team to retrieve.

namestringOptional

Optional team name to filter teams.

external_idstringOptional

Optional external ID to filter teams.

skipintegerOptional

Number of items to skip for pagination.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field to sort by (e.g., team_name, external_id).

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
include_membersbooleanOptional

Return total_members count and the first 10 members

Responses
200

OK

application/json
get
GET /directory/v1/teams HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "teams": [
      {
        "team_id": "text",
        "name": "text",
        "external_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 1
      },
      "total_results": 1
    }
  },
  "identifier": "text"
}
post

Create multiple new teams in a single request.

Authorizations
Body
Responses
200

Created

application/json
post
POST /directory/v1/teams HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "teams": [
    {
      "name": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "teams": [
      {
        "team_id": "text",
        "name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
put

Update multiple existing teams by their IDs.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /directory/v1/teams HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "teams": [
    {
      "team_id": "text",
      "name": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "teams": [
      {
        "team_id": "text",
        "name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
delete

Delete multiple teams by their IDs.

Authorizations
Body
Responses
200

OK

application/json
delete
DELETE /directory/v1/teams HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "teams": [
    {
      "team_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "teams": [
      {
        "team_id": "text"
      }
    ]
  },
  "identifier": "text"
}
get

Retrieve a list of team members, with optional filters for team ID, person ID, or external ID.

Authorizations
Path parameters
team_idstringRequired

The team ID to query

Query parameters
skipintegerOptional

Number of items to skip for pagination.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field to sort by (e.g., team_id, people_id).

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
people_idstringOptional

Unique identifier of the members to filter

emailstringOptional

Email of the members to filter

first_namestringOptional

First name of the members to filter

last_namestringOptional

Last name of the members to filter

external_idstringOptional

External identifier of the members to filter

Responses
200

OK

application/json
get
GET /directory/v1/teams/{team_id}/members HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "members": [
      {
        "people_id": "text",
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "external_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 1
      },
      "total_results": 1
    }
  },
  "identifier": "text"
}
put

Add multiple members to teams in a single request.

Authorizations
Body
Responses
200

Created

application/json
put
PUT /directory/v1/teams/{team_id}/members HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "members": [
    {
      "people_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "members_added": [
      "text"
    ]
  },
  "identifier": "text"
}
delete

Remove multiple members from teams.

Authorizations
Body
Responses
200

OK

application/json
delete
DELETE /directory/v1/teams/{team_id}/members HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "members": [
    {
      "people_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "members": [
      "text"
    ]
  },
  "identifier": "text"
}
PreviousSpatial APINextWorkplace API

Last updated

Was this helpful?