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
person_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.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

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": [
      {
        "_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.

Authorizations
Body
Responses
201
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": [
      {
        "_id": "text",
        "email": "text",
        "first_name": "text",
        "last_name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
put

Update multiple existing people.

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: 102

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

Delete multiple people by their IDs.

Authorizations
Body
people_idsstring[]Required

List of people IDs to delete.

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

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

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

Authorizations
Query parameters
team_idstringOptional

Optional ID of the team to retrieve.

team_namestringOptional

Optional team name to filter teams.

external_idstringOptional

Optional external ID to filter teams.

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'.

Default: ascPossible values:
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": [
      {
        "_id": "text",
        "team_name": "text",
        "external_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 1
      },
      "total_results": 1
    }
  },
  "identifier": "text"
}
post

Create multiple new teams.

Authorizations
Body
Responses
201
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: 53

{
  "teams": [
    {
      "team_name": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "teams": [
      {
        "_id": "text",
        "team_name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
put

Update multiple existing teams.

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: 66

{
  "teams": [
    {
      "_id": "text",
      "team_name": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "teams": [
      {
        "_id": "text",
        "team_name": "text",
        "external_id": "text"
      }
    ]
  },
  "identifier": "text"
}
post

Delete multiple teams by their IDs.

Authorizations
Body
team_idsstring[]Required

List of team IDs to delete.

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

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

Retrieve a list of SCIM Users or filter users per SCIM 2.0 specification.

Authorizations
Query parameters
filterstringOptional

SCIM filter expression (e.g., userName eq "[email protected]"). Supports filtering by userName, name.givenName, name.familyName, externalId.

startIndexinteger · min: 1Optional

1-based index for pagination.

Default: 1
countintegerOptional

Maximum number of items to return.

Default: 25
sortBystringOptional

Field to sort by (e.g., userName, name.givenName).

sortOrderstring · enumOptional

Sort order, "ascending" or "descending".

Default: ascendingPossible values:
Responses
200
OK
application/scim+json
get
GET /directory/v1/scim/Users HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "schemas": [
    "text"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "id": "text",
      "userName": "text",
      "name": {
        "givenName": "text",
        "familyName": "text"
      },
      "externalId": "text",
      "schemas": [
        "text"
      ],
      "meta": {
        "resourceType": "text",
        "created": "2025-07-19T01:22:20.401Z",
        "lastModified": "2025-07-19T01:22:20.401Z"
      }
    }
  ]
}
post

Create one or more SCIM Users.

Authorizations
Body
schemasstring[]Required

SCIM schemas for the request.

userNamestringRequired

Unique identifier for the user, typically an email.

externalIdstring | nullableOptional

External identifier for the user.

Responses
201
Created
application/scim+json
post
POST /directory/v1/scim/Users HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/scim+json
Accept: */*
Content-Length: 106

{
  "schemas": [
    "text"
  ],
  "userName": "text",
  "name": {
    "givenName": "text",
    "familyName": "text"
  },
  "externalId": "text"
}
{
  "id": "text",
  "userName": "text",
  "name": {
    "givenName": "text",
    "familyName": "text"
  },
  "externalId": "text",
  "schemas": [
    "text"
  ],
  "meta": {
    "resourceType": "text",
    "created": "2025-07-19T01:22:20.401Z",
    "lastModified": "2025-07-19T01:22:20.401Z"
  }
}
get

Retrieve a list of SCIM Groups or filter groups per SCIM 2.0 specification.

Authorizations
Query parameters
filterstringOptional

SCIM filter expression (e.g., displayName eq "Accounting"). Supports filtering by displayName, externalId.

startIndexinteger · min: 1Optional

1-based index for pagination.

Default: 1
countintegerOptional

Maximum number of items to return.

Default: 25
sortBystringOptional

Field to sort by (e.g., displayName).

sortOrderstring · enumOptional

Sort order, "ascending" or "descending".

Default: ascendingPossible values:
Responses
200
OK
application/scim+json
get
GET /directory/v1/scim/Groups HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "schemas": [
    "text"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "id": "text",
      "displayName": "text",
      "externalId": "text",
      "schemas": [
        "text"
      ],
      "meta": {
        "resourceType": "text",
        "created": "2025-07-19T01:22:20.401Z",
        "lastModified": "2025-07-19T01:22:20.401Z"
      }
    }
  ]
}
post

Create one or more SCIM Groups.

Authorizations
Body
schemasstring[]Required

SCIM schemas for the request.

displayNamestringRequired

Name of the group.

externalIdstring | nullableOptional

External identifier for the group.

Responses
201
Created
application/scim+json
post
POST /directory/v1/scim/Groups HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/scim+json
Accept: */*
Content-Length: 61

{
  "schemas": [
    "text"
  ],
  "displayName": "text",
  "externalId": "text"
}
{
  "id": "text",
  "displayName": "text",
  "externalId": "text",
  "schemas": [
    "text"
  ],
  "meta": {
    "resourceType": "text",
    "created": "2025-07-19T01:22:20.401Z",
    "lastModified": "2025-07-19T01:22:20.401Z"
  }
}
post

Perform bulk operations (create, update, delete) for SCIM Users and Groups.

Authorizations
Body
schemasstring[]Required

SCIM schemas for the bulk request.

Responses
200
OK
application/scim+json
post
POST /directory/v1/scim/Bulk HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/scim+json
Accept: */*
Content-Length: 230

{
  "schemas": [
    "text"
  ],
  "Operations": [
    {
      "method": "POST",
      "path": "text",
      "bulkId": "text",
      "data": {
        "id": "text",
        "userName": "text",
        "name": {
          "givenName": "text",
          "familyName": "text"
        },
        "displayName": "text",
        "externalId": "text",
        "schemas": [
          "text"
        ]
      }
    }
  ]
}
{
  "schemas": [
    "text"
  ],
  "Operations": [
    {
      "bulkId": "text",
      "method": "text",
      "location": "text",
      "status": "text",
      "response": {
        "id": "text",
        "userName": "text",
        "name": {},
        "displayName": "text",
        "externalId": "text",
        "schemas": [
          "text"
        ],
        "meta": {
          "resourceType": "text",
          "created": "2025-07-19T01:22:20.401Z",
          "lastModified": "2025-07-19T01:22:20.401Z"
        }
      }
    }
  ]
}
PreviousSpatial APINextConnections API

Last updated

Was this helpful?