Onboarding progress derived from tenant state

GET

/v1/setup

const url = 'https://api.fromenance.com/v1/setup';
const options = {
  method: 'GET',
  headers: {cookie: 'fromenance.session_token=<fromenance.session_token>'}
};

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

curl --request GET \
  --url https://api.fromenance.com/v1/setup \
  --cookie fromenance.session_token=<fromenance.session_token>

Authorizations

Session
ApiKey

Responses

200

Progress

application/json

object

steps

required

object

tenant

required

boolean

domain_verified

required

boolean

forwarding_working

required

boolean

reply_identity

required

boolean

first_stream

required

boolean

footer_deployed

required

boolean

live

required

boolean

domains

required

Array<object>

object

required

string

domain

required

string

status

required

string

forwarding

required

object

status

required

string

Allowed values: not_started sent working failed

sent_at

required

string | null

passed_at

required

string | null

result

required

string | null

required

string

Example

{
  "domains": [
    {
      "forwarding": {
        "status": "not_started"
      }
    }
  ]
}