Connections API

get

Retrieve a list of connections or a specific connection by ID, with optional filters for entity ID, entity type, or external ID.

Authorizations

x-api-keystringRequired

Query parameters

connection_idstringOptional

Optional ID of the connection to retrieve.

connection_entity_idstringOptional

Optional ID of an entity to filter connections (e.g., TEAM, PERSON, LABEL, SPACE, ROOM, or ZONE ID).

connection_entity_typestring · enumOptional

Optional type of entity to filter connections.

Possible values:

external_idstringOptional

Optional external ID to filter connections (matches external_id of PERSON or TEAM entities in connection_from_entity or connection_to_entity).

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., strength, connection_from_entity.connection_entity_id).

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:

Responses

200

application/json

400

Bad Request

application/json

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": "random-id-1",
        "strength": -50,
        "connection_from_entity": {
          "connection_entity_id": "random-id-2",
          "connection_entity_type": "PERSON",
          "connection_entity_data": {
            "first_name": "Christian",
            "last_name": "Marca",
            "email": "[email protected]",
            "person_id": "random-id-2",
            "external_id": "ext-123"
          }
        },
        "connection_to_entity": {
          "connection_entity_id": "random-id-3",
          "connection_entity_type": "TEAM",
          "connection_entity_data": {
            "team_name": "Accounting",
            "team_id": "random-id-3",
            "external_id": "ext-456"
          }
        }
      },
      {
        "_id": "random-id-4",
        "strength": 75,
        "connection_from_entity": {
          "connection_entity_id": "random-id-5",
          "connection_entity_type": "TEAM",
          "connection_entity_data": {
            "team_name": "Planning",
            "team_id": "random-id-5",
            "external_id": "ext-789"
          }
        },
        "connection_to_entity": {
          "connection_entity_id": "random-id-6",
          "connection_entity_type": "ROOM",
          "connection_entity_data": {
            "room_name": "Conference Room A",
            "room_id": "random-id-6"
          }
        }
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_connections_successful"
}

post

Create multiple new connections.

Authorizations

x-api-keystringRequired

Body

Responses

201

Created

application/json

400

Bad Request

application/json

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

{
  "connections": [
    {
      "strength": -50,
      "connection_from_entity": {
        "connection_entity_id": "random-id-2",
        "connection_entity_type": "PERSON",
        "connection_entity_data": {
          "first_name": "Christian",
          "last_name": "Marca",
          "email": "[email protected]",
          "person_id": "random-id-2",
          "external_id": "ext-123"
        }
      },
      "connection_to_entity": {
        "connection_entity_id": "random-id-3",
        "connection_entity_type": "TEAM",
        "connection_entity_data": {
          "team_name": "Accounting",
          "team_id": "random-id-3",
          "external_id": "ext-456"
        }
      }
    },
    {
      "strength": 75,
      "connection_from_entity": {
        "connection_entity_id": "random-id-5",
        "connection_entity_type": "TEAM",
        "connection_entity_data": {
          "team_name": "Planning",
          "team_id": "random-id-5",
          "external_id": "ext-789"
        }
      },
      "connection_to_entity": {
        "connection_entity_id": "random-id-6",
        "connection_entity_type": "ROOM",
        "connection_entity_data": {
          "room_name": "Conference Room A",
          "room_id": "random-id-6"
        }
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "connections": [
      {
        "_id": "random-id-1",
        "strength": -50,
        "connection_from_entity": {
          "connection_entity_id": "random-id-2",
          "connection_entity_type": "PERSON",
          "connection_entity_data": {
            "first_name": "Christian",
            "last_name": "Marca",
            "email": "[email protected]",
            "person_id": "random-id-2",
            "external_id": "ext-123"
          }
        },
        "connection_to_entity": {
          "connection_entity_id": "random-id-3",
          "connection_entity_type": "TEAM",
          "connection_entity_data": {
            "team_name": "Accounting",
            "team_id": "random-id-3",
            "external_id": "ext-456"
          }
        }
      },
      {
        "_id": "random-id-4",
        "strength": 75,
        "connection_from_entity": {
          "connection_entity_id": "random-id-5",
          "connection_entity_type": "TEAM",
          "connection_entity_data": {
            "team_name": "Planning",
            "team_id": "random-id-5",
            "external_id": "ext-789"
          }
        },
        "connection_to_entity": {
          "connection_entity_id": "random-id-6",
          "connection_entity_type": "ROOM",
          "connection_entity_data": {
            "room_name": "Conference Room A",
            "room_id": "random-id-6"
          }
        }
      }
    ]
  },
  "identifier": "create_connections_successful"
}

put

Update multiple existing connections.

Authorizations

x-api-keystringRequired

Body

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

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

{
  "connections": [
    {
      "_id": "random-id-1",
      "strength": -40,
      "connection_from_entity": {
        "connection_entity_id": "random-id-2",
        "connection_entity_type": "PERSON",
        "connection_entity_data": {
          "first_name": "Christian",
          "last_name": "Marca",
          "email": "[email protected]",
          "person_id": "random-id-2",
          "external_id": "ext-123"
        }
      },
      "connection_to_entity": {
        "connection_entity_id": "random-id-3",
        "connection_entity_type": "TEAM",
        "connection_entity_data": {
          "team_name": "Accounting Updated",
          "team_id": "random-id-3",
          "external_id": "ext-456"
        }
      }
    },
    {
      "_id": "random-id-4",
      "strength": 80,
      "connection_from_entity": {
        "connection_entity_id": "random-id-5",
        "connection_entity_type": "TEAM",
        "connection_entity_data": {
          "team_name": "Planning Updated",
          "team_id": "random-id-5",
          "external_id": "ext-789"
        }
      },
      "connection_to_entity": {
        "connection_entity_id": "random-id-6",
        "connection_entity_type": "ROOM",
        "connection_entity_data": {
          "room_name": "Conference Room A Updated",
          "room_id": "random-id-6"
        }
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "connections": [
      {
        "_id": "random-id-1",
        "strength": -40,
        "connection_from_entity": {
          "connection_entity_id": "random-id-2",
          "connection_entity_type": "PERSON",
          "connection_entity_data": {
            "first_name": "Christian",
            "last_name": "Marca",
            "email": "[email protected]",
            "person_id": "random-id-2",
            "external_id": "ext-123"
          }
        },
        "connection_to_entity": {
          "connection_entity_id": "random-id-3",
          "connection_entity_type": "TEAM",
          "connection_entity_data": {
            "team_name": "Accounting Updated",
            "team_id": "random-id-3",
            "external_id": "ext-456"
          }
        }
      },
      {
        "_id": "random-id-4",
        "strength": 80,
        "connection_from_entity": {
          "connection_entity_id": "random-id-5",
          "connection_entity_type": "TEAM",
          "connection_entity_data": {
            "team_name": "Planning Updated",
            "team_id": "random-id-5",
            "external_id": "ext-789"
          }
        },
        "connection_to_entity": {
          "connection_entity_id": "random-id-6",
          "connection_entity_type": "ROOM",
          "connection_entity_data": {
            "room_name": "Conference Room A Updated",
            "room_id": "random-id-6"
          }
        }
      }
    ]
  },
  "identifier": "update_connections_successful"
}

delete

Delete multiple connections by their IDs.

Authorizations

x-api-keystringRequired

Body

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

delete

/connections

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

{
  "connections": [
    {
      "connection_id": "random-id-1"
    },
    {
      "connection_id": "random-id-4"
    }
  ]
}

{
  "success": true,
  "data": {
    "connections": [
      {
        "connection_id": "random-id-1"
      },
      {
        "connection_id": "random-id-4"
      }
    ]
  },
  "identifier": "delete_connections_successful"
}

get

Retrieve a list of labels or a specific label by ID.

Authorizations

x-api-keystringRequired

Query parameters

label_idstringOptional

Optional ID of the label to retrieve.

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., name, type).

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:

Responses

200

application/json

400

Bad Request

application/json

get

/labels

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

{
  "success": true,
  "data": {
    "labels": [
      {
        "_id": "random-id-7",
        "name": "Label A",
        "type": "category",
        "details": {
          "color": "blue",
          "description": "Primary category"
        }
      },
      {
        "_id": "random-id-8",
        "name": "Label B",
        "type": "tag",
        "details": {
          "color": "green",
          "description": "Secondary tag"
        }
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_labels_successful"
}

post

Create multiple new labels.

Authorizations

x-api-keystringRequired

Body

Responses

201

Created

application/json

400

Bad Request

application/json

post

/labels

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

{
  "labels": [
    {
      "name": "Label A",
      "type": "category",
      "details": {
        "color": "blue",
        "description": "Primary category"
      }
    },
    {
      "name": "Label B",
      "type": "tag",
      "details": {
        "color": "green",
        "description": "Secondary tag"
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "labels": [
      {
        "_id": "random-id-7",
        "name": "Label A",
        "type": "category",
        "details": {
          "color": "blue",
          "description": "Primary category"
        }
      },
      {
        "_id": "random-id-8",
        "name": "Label B",
        "type": "tag",
        "details": {
          "color": "green",
          "description": "Secondary tag"
        }
      }
    ]
  },
  "identifier": "create_labels_successful"
}

put

Update multiple existing labels.

Authorizations

x-api-keystringRequired

Body

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/labels

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

{
  "labels": [
    {
      "_id": "random-id-7",
      "name": "Label A Updated",
      "type": "category",
      "details": {
        "color": "red",
        "description": "Updated primary category"
      }
    },
    {
      "_id": "random-id-8",
      "name": "Label B Updated",
      "type": "tag",
      "details": {
        "color": "yellow",
        "description": "Updated secondary tag"
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "labels": [
      {
        "_id": "random-id-7",
        "name": "Label A Updated",
        "type": "category",
        "details": {
          "color": "red",
          "description": "Updated primary category"
        }
      },
      {
        "_id": "random-id-8",
        "name": "Label B Updated",
        "type": "tag",
        "details": {
          "color": "yellow",
          "description": "Updated secondary tag"
        }
      }
    ]
  },
  "identifier": "update_labels_successful"
}

delete

Delete multiple labels by their IDs.

Authorizations

x-api-keystringRequired

Body

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

delete

/labels

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

{
  "labels": [
    {
      "label_id": "random-id-7"
    },
    {
      "label_id": "random-id-8"
    }
  ]
}

{
  "success": true,
  "data": {
    "labels": [
      {
        "label_id": "random-id-7"
      },
      {
        "label_id": "random-id-8"
      }
    ]
  },
  "identifier": "delete_labels_successful"
}

get

Retrieve a list of label mappings or a specific mapping by ID, with optional filters for label ID, entity ID, entity type, or external ID.

Authorizations

x-api-keystringRequired

Query parameters

mapping_idstringOptional

Optional ID of the mapping to retrieve.

label_idstringOptional

Optional ID of a label to filter mappings.

entity_idstringOptional

Optional ID of an entity to filter mappings (e.g., TEAM, PERSON, LABEL, SPACE, ROOM, or ZONE ID).

entity_typestring · enumOptional

Optional type of entity to filter mappings.

Possible values:

external_idstringOptional

Optional external ID to filter mappings (matches external_id of PERSON or TEAM entities).

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., label_id, entity_id).

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:

Responses

200

application/json

400

Bad Request

application/json

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": {
    "mappings": [
      {
        "_id": "random-id-9",
        "label_id": "random-id-7",
        "entity_id": "random-id-2",
        "entity_type": "PERSON",
        "details": {
          "applied_at": "2025-07-18T12:00:00Z",
          "external_id": "ext-123"
        }
      },
      {
        "_id": "random-id-10",
        "label_id": "random-id-8",
        "entity_id": "random-id-3",
        "entity_type": "TEAM",
        "details": {
          "applied_at": "2025-07-18T12:01:00Z",
          "external_id": "ext-456"
        }
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_mappings_successful"
}

post

Create multiple new label mappings.

Authorizations

x-api-keystringRequired

Body

Responses

201

Created

application/json

400

Bad Request

application/json

post

/labels/mapping

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

{
  "mappings": [
    {
      "label_id": "random-id-7",
      "entity_id": "random-id-2",
      "entity_type": "PERSON",
      "details": {
        "applied_at": "2025-07-18T12:00:00Z",
        "external_id": "ext-123"
      }
    },
    {
      "label_id": "random-id-8",
      "entity_id": "random-id-3",
      "entity_type": "TEAM",
      "details": {
        "applied_at": "2025-07-18T12:01:00Z",
        "external_id": "ext-456"
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "mappings": [
      {
        "_id": "random-id-9",
        "label_id": "random-id-7",
        "entity_id": "random-id-2",
        "entity_type": "PERSON",
        "details": {
          "applied_at": "2025-07-18T12:00:00Z",
          "external_id": "ext-123"
        }
      },
      {
        "_id": "random-id-10",
        "label_id": "random-id-8",
        "entity_id": "random-id-3",
        "entity_type": "TEAM",
        "details": {
          "applied_at": "2025-07-18T12:01:00Z",
          "external_id": "ext-456"
        }
      }
    ]
  },
  "identifier": "create_mappings_successful"
}

put

Update multiple existing label mappings.

Authorizations

x-api-keystringRequired

Body

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/labels/mapping

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

{
  "mappings": [
    {
      "_id": "random-id-9",
      "label_id": "random-id-7",
      "entity_id": "random-id-2",
      "entity_type": "PERSON",
      "details": {
        "applied_at": "2025-07-18T12:02:00Z",
        "external_id": "ext-123"
      }
    },
    {
      "_id": "random-id-10",
      "label_id": "random-id-8",
      "entity_id": "random-id-3",
      "entity_type": "TEAM",
      "details": {
        "applied_at": "2025-07-18T12:03:00Z",
        "external_id": "ext-456"
      }
    }
  ]
}

{
  "success": true,
  "data": {
    "mappings": [
      {
        "_id": "random-id-9",
        "label_id": "random-id-7",
        "entity_id": "random-id-2",
        "entity_type": "PERSON",
        "details": {
          "applied_at": "2025-07-18T12:02:00Z",
          "external_id": "ext-123"
        }
      },
      {
        "_id": "random-id-10",
        "label_id": "random-id-8",
        "entity_id": "random-id-3",
        "entity_type": "TEAM",
        "details": {
          "applied_at": "2025-07-18T12:03:00Z",
          "external_id": "ext-456"
        }
      }
    ]
  },
  "identifier": "update_mappings_successful"
}

delete

Delete multiple label mappings by their IDs.

Authorizations

x-api-keystringRequired

Body

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

delete

/labels/mapping

DELETE /connections/v1/labels/mapping HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "mappings": [
    {
      "mapping_id": "random-id-9"
    },
    {
      "mapping_id": "random-id-10"
    }
  ]
}

{
  "success": true,
  "data": {
    "mappings": [
      {
        "mapping_id": "random-id-9"
      },
      {
        "mapping_id": "random-id-10"
      }
    ]
  },
  "identifier": "delete_mappings_successful"
}

PreviousWorkplace API NextSystem API

Last updated 5 months ago

Was this helpful?