Get available onboarding sources

GET

/api/v1/onboarding/sources

const url = 'http://localhost:11044/api/v1/onboarding/sources';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/onboarding/sources \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

apiKeyAuth
basicAuth

Responses

200

*/*

The sources the Get-to-Know-Me flow knows, answered by GET /onboarding/sources

object

sources

required

Every known source, available or not, in a fixed order

Array<object>

A source the Get-to-Know-Me flow can profile, and whether it can be used now

object

available

required

Whether the source can be profiled now. False when no contributor for it is currently available on this server

boolean

required

Stable source id to send in an onboarding request: email, calendar or osx

string

label

required

Human-readable name to show for the source

string