Skip to main content

Relationships API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
relationshipsSnapshotGET /relationships/relationships [GET]

relationshipsSnapshot

Relationships relationshipsSnapshot()

This will return all of the relationships that exists within your pieces db.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.RelationshipsApi(configuration)

apiInstance.relationshipsSnapshot().then((data: Relationships) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

This endpoint does not need any parameters.

Return type

Relationships

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-