The organization's email domains

GET

/api/v1/email-domains

curl --request GET \
  --url http://localhost:3000/api/v1/email-domains \
  --header 'Authorization: Bearer <token>'

The domains its people have their email at, proved or not. Organization admin.

Scope: admin.

Authorizations

• bearer
• session
• None

Responses

200

Email domains

Media typeapplication/json

object

data

required

Array<object>

object

domain

required

string

verified

required

Proved by its TXT record: single sign-on and joining by domain may use it

boolean

join

required

Anyone whose address is at exactly this domain may join the organization, able to read its landing project

boolean

projectId

required

The project whoever joins lands in, able to read; null for the organization’s oldest

string | null

sso

required

The organization’s single sign-on uses it

boolean

record

required

What proves the domain: add this record at your DNS host

object

type

required

string

Allowed value: TXT

name

required

string

value

required

string

Example

{
  "data": [
    {
      "record": {
        "type": "TXT"
      }
    }
  ]
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}