Connections API

get

Retrieve a list of connections or a specific connection by ID.

Authorizations

x-api-keystringRequired

Query parameters

connection_idstringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

application/json

successbooleanRequired

identifierstringRequired

500

Internal Server Error

get/connections

GET /connections/v1/connections HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "connections": [
      {
        "_id": "text",
        "connection_from_entity": {
          "connection_entity_id": "text",
          "connection_entity_type": "PERSON",
          "connection_entity_data": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "connection_to_entity": {
          "connection_entity_id": "text",
          "connection_entity_type": "PERSON",
          "connection_entity_data": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "strength": 1,
        "priority": 1,
        "status": "text",
        "configuration_id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

post

Create multiple connections in a single request.

Authorizations

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

Responses

200

application/json

successbooleanRequired

identifierstringRequired

500

Internal Server Error

post/connections

POST /connections/v1/connections HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "connections": [
    {
      "connection_from_entity_id": "text",
      "connection_to_entity_id": "text",
      "strength": 1,
      "priority": 1,
      "starts_at": "2026-01-01T00:00:00.000Z",
      "ends_at": "2026-01-01T00:00:00.000Z",
      "notes": "text",
      "location_id": "text"
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "connection_from_entity": {
        "connection_entity_id": "text",
        "connection_entity_type": "PERSON",
        "connection_entity_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "connection_to_entity": {
        "connection_entity_id": "text",
        "connection_entity_type": "PERSON",
        "connection_entity_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "strength": 1,
      "priority": 1,
      "status": "text",
      "configuration_id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Edit multiple connections in a single request.

Authorizations

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

Responses

200

application/json

successbooleanRequired

identifierstringRequired

500

Internal Server Error

put/connections

PUT /connections/v1/connections HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "connections": [
    {
      "connection_id": "text",
      "strength": 1,
      "priority": 1,
      "starts_at": "2026-01-01T00:00:00.000Z",
      "ends_at": "2026-01-01T00:00:00.000Z",
      "notes": "text"
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "connection_from_entity": {
        "connection_entity_id": "text",
        "connection_entity_type": "PERSON",
        "connection_entity_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "connection_to_entity": {
        "connection_entity_id": "text",
        "connection_entity_type": "PERSON",
        "connection_entity_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "strength": 1,
      "priority": 1,
      "status": "text",
      "configuration_id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

get

Retrieve label definitions.

Authorizations

x-api-keystringRequired

Query parameters

label_idstringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

application/json

successbooleanRequired

identifierstringRequired

500

Internal Server Error

get/labels

GET /connections/v1/labels HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "labels": [
      {
        "connection_entity_id": "text",
        "connection_entity_type": "PERSON",
        "entity_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "flags": {
          "connectable": true,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "location_id": "text",
        "configuration_id": "text",
        "status": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve label mappings.

Authorizations

x-api-keystringRequired

Query parameters

label_mapping_idstringOptional

label_idstringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

application/json

successbooleanRequired

identifierstringRequired

500

Internal Server Error

get/labels/mapping

GET /connections/v1/labels/mapping HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "label_mappings": [
      {
        "connection_entity_id": "text",
        "label_definition_entity_id": "text",
        "value": "text",
        "entity_type": "text",
        "visibility": "text",
        "location_id": "text",
        "configuration_id": "text",
        "status": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

PreviousDirectory API

NextSystem API

Last updated 7 months ago