Current tenant

GET

/v1/tenant

const url = 'https://api.fromenance.com/v1/tenant';
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/tenant \
  --cookie fromenance.session_token=<fromenance.session_token>

Authorizations

Session
ApiKey

Responses

200

Tenant

application/json

object

required

string

slug

required

string

name

required

string

plan

required

string

status

required

string

authoritative_mode

required

boolean

authoritative_since

required

string | null

retention_days

required

integer

reply_mode

required

Any of:

string
string

string

Allowed values: minimal branded

reply_from_name

required

string | null

reply_domain_id

required

string | null

fraud_contact

required

string | null

verify_page_url

required

string | null

verify_address

required

string

journal_address

required

string

minimal_reply_address

required

string

branding

required

object

key

additional properties

match_threshold

required

integer

sandbox

required

boolean

expected_daily_volume

required

integer | null

created_at

required

string

Example

{
  "reply_mode": "minimal"
}

401

Unauthorized

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

string

instance

string

errors

Present on validation problems.

Array<object>

object

path

required

string

message

required

string

request_id

string

Example

{
  "type": "https://docs.fromenance.com/api/errors#validation",
  "title": "Validation failed",
  "status": 400,
  "detail": "recipient_hash must start with hmac-sha256:",
  "instance": "/v1/communications"
}