Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Network API

6 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

network.introductions

Your Connections programs, when your next introduction goes out, and who you met

POST/api/v1/manage/network/introductions

const result = await shuffl.network.introductions();
Request fields (none)

This operation takes no input.

Response object

The response is object.

network.mine

Who you know and who you should meet

POST/api/v1/manage/network/mine

const result = await shuffl.network.mine();
Request fields (none)

This operation takes no input.

Response object

The response is object.

network.ofPerson

People you and this person both know

POST/api/v1/manage/network/ofPerson

const result = await shuffl.network.ofPerson({
  "personId": "<personId>"
});
Request fields (1)
  • personId string required
Response object

The response is object.

network.orgChart

Everyone in the team with their manager, for the org chart

POST/api/v1/manage/network/orgChart

const result = await shuffl.network.orgChart();
Request fields (none)

This operation takes no input.

Response object
  • ownPersonId null | string required
  • rows object[] required
    • department null | string required
    • groups string[] required
    • id string required
    • managerId null | string required
    • name string required
    • photoUrl null | string required
    • title null | string required
    • userId null | string required

network.claim

Say you know someone or would like to meet them

POST/api/v1/manage/network/claim

  • Write
  • Permission network.claim
  • Needs a requestKey
  • Needs confirm set to network.claim
const result = await shuffl.network.claim({
  "kind": "knows",
  "on": false,
  "personId": "<personId>",
  "confirm": "network.claim",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • kind "knows" | "wants_to_meet" required
  • on boolean required
  • personId string required
  • confirm "network.claim" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • confirmed boolean required
    • knows boolean required
    • wantsToMeet boolean required

network.requestIntro

Ask someone you both know to introduce you

POST/api/v1/manage/network/requestIntro

const result = await shuffl.network.requestIntro({
  "personId": "<personId>",
  "viaId": "<viaId>",
  "confirm": "network.requestIntro",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • personId string required
  • viaId string required
  • confirm "network.requestIntro" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • created boolean required
    • id string required
    • state "asked" required