Ctrlk
gospace AIDocsAdmin ConsoleHelp
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Partner API

get

List child organisations owned by the authenticated partner. Deleted organisations are excluded by default.

Authorizations
x-api-keystringRequired
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault: 50
skipintegerOptionalDefault: 0
include_deletedbooleanOptionalDefault: false
Responses
200

Organisations listed.

application/json
successbooleanRequired
identifierstring · enumRequiredPossible values:
get/organisations
GET /partner/v1/organisations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "identifier": "partner_organisations_listed",
  "data": [
    {
      "organisation_id": "65f1a7a8260c3f3322a0e1b9",
      "organisation_key": "prod_123456789abc",
      "organisation_name": "Example Child Organisation",
      "country": "GB",
      "division_key": "1c3906b5-d770-4d82-9d0c-c22f1c12e6aa",
      "deleted_at": "2026-01-01T00:00:00.000Z",
      "partner_external_id": "customer-12345",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}
post

Create a child organisation owned by the authenticated partner. The response includes one newly generated standard organisation API key. Use that child organisation API key for data writes into the child organisation.

Authorizations
x-api-keystringRequired
Body
organisation_namestring · min: 1RequiredExample: Example Child Organisation
countrystring · min: 2 · max: 2Required

ISO 3166-1 alpha-2 country code.

Example: GB
division_timezonestring · min: 1RequiredExample: Europe/London
division_namestring · min: 1Optional

Optional name for the initial division. Defaults to organisation_name.

Example: Headquarters
partner_external_idstring · min: 1Optional

Optional partner-side identifier for this organisation.

Example: customer-12345
Responses
200

Organisation created.

application/json
successbooleanRequired
identifierstring · enumRequiredPossible values:
post/organisations
POST /partner/v1/organisations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "organisation_name": "Example Child Organisation",
  "country": "GB",
  "division_timezone": "Europe/London",
  "division_name": "Headquarters",
  "partner_external_id": "customer-12345"
}
{
  "success": true,
  "identifier": "partner_organisation_created",
  "data": {
    "organisation_id": "65f1a7a8260c3f3322a0e1b9",
    "organisation_key": "prod_123456789abc",
    "organisation_name": "Example Child Organisation",
    "country": "GB",
    "division_key": "1c3906b5-d770-4d82-9d0c-c22f1c12e6aa",
    "deleted_at": null,
    "partner_external_id": "customer-12345",
    "created_at": "2026-04-22T09:00:00.000Z",
    "updated_at": "2026-04-22T09:00:00.000Z",
    "organisation_api_key": "prod_123456789abc.gb.1c3906b5-d770-4d82-9d0c-c22f1c12e6aa.4f9f2d80-0de8-478f-a55d-2f3376fe7a8b"
  }
}
get

Retrieve one child organisation by MongoDB organisation ID. Organisations not owned by the authenticated partner are rejected.

Authorizations
x-api-keystringRequired
Path parameters
organisation_idstringRequiredPattern: ^[a-f\\d]{24}$
Query parameters
include_deletedbooleanOptionalDefault: false
Responses
200

Organisation found.

application/json
successbooleanRequired
identifierstring · enumRequiredPossible values:
get/organisations/{organisation_id}
GET /partner/v1/organisations/{organisation_id} HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "identifier": "partner_organisation_found",
  "data": {
    "organisation_id": "65f1a7a8260c3f3322a0e1b9",
    "organisation_key": "prod_123456789abc",
    "organisation_name": "Example Child Organisation",
    "country": "GB",
    "division_key": "1c3906b5-d770-4d82-9d0c-c22f1c12e6aa",
    "deleted_at": "2026-01-01T00:00:00.000Z",
    "partner_external_id": "customer-12345",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}
delete

Soft-delete an owned child organisation and revoke its organisation API keys. If the deleted target is itself a partner organisation, child organisations linked to that partner are also soft-deleted and their keys revoked.

Authorizations
x-api-keystringRequired
Path parameters
organisation_idstringRequiredPattern: ^[a-f\\d]{24}$
Responses
200

Organisation deleted.

application/json
successbooleanRequired
identifierstring · enumRequiredPossible values:
delete/organisations/{organisation_id}
DELETE /partner/v1/organisations/{organisation_id} HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "identifier": "partner_organisation_deleted",
  "data": {
    "organisation_ids": [
      "text"
    ]
  }
}
patch

Update safe partner-facing organisation metadata only. Fields such as country, location, shard_key, organisation_key, divisions, is_partner, and ownership fields cannot be updated through this API.

Authorizations
x-api-keystringRequired
Path parameters
organisation_idstringRequiredPattern: ^[a-f\\d]{24}$
Body
organisation_namestring · min: 1Optional
partner_external_idstring · min: 1Optional
Responses
200

Organisation updated.

application/json
successbooleanRequired
identifierstring · enumRequiredPossible values:
patch/organisations/{organisation_id}
PATCH /partner/v1/organisations/{organisation_id} HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "organisation_name": "Updated Child Organisation",
  "partner_external_id": "customer-12345-updated"
}
{
  "success": true,
  "identifier": "partner_organisation_updated",
  "data": {
    "organisation_id": "65f1a7a8260c3f3322a0e1b9",
    "organisation_key": "prod_123456789abc",
    "organisation_name": "Example Child Organisation",
    "country": "GB",
    "division_key": "1c3906b5-d770-4d82-9d0c-c22f1c12e6aa",
    "deleted_at": "2026-01-01T00:00:00.000Z",
    "partner_external_id": "customer-12345",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}
get

Retrieve storage and API request usage for an owned child organisation for a single month. Monthly totals are returned when available; otherwise daily storage and API usage records are aggregated.

Authorizations
x-api-keystringRequired
Path parameters
organisation_idstringRequiredPattern: ^[a-f\\d]{24}$
Query parameters
usage_monthstringRequiredExample: 2026-04Pattern: ^\\d{4}-\\d{2}$
Responses
200

Usage found.

application/json
successbooleanRequired
identifierstring · enumRequiredPossible values:
get/organisations/{organisation_id}/usage
GET /partner/v1/organisations/{organisation_id}/usage?usage_month=2026-04 HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "identifier": "partner_organisation_usage_found",
  "data": {
    "organisation_id": "text",
    "organisation_key": "text",
    "usage_month": "2026-04",
    "timezone": "UTC",
    "total_bytes": 0,
    "total_documents": 0,
    "days_recorded": 0,
    "peak_total_bytes": 0,
    "peak_total_documents": 0,
    "total_requests": 0,
    "api_days_recorded": 0,
    "peak_total_requests": 0
  }
}
PreviousCreate connections and label space
NextModels

Last updated