Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "match": null,
    "invitation": {
      "invitationId": "orginv_2abcXYZ",
      "orgId": "org_2abcXYZ",
      "orgName": "Acme Co",
      "email": "jane@acme.com",
      "role": "staff"
    }
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Onboarding

Discover the workspace that invited you, or the one your email domain belongs to

Called by a just-signed-in account that has no workspace yet, BEFORE offering to create one. It returns two independent, server-derived answers about the caller’s own VERIFIED identity — never about any address supplied in the request (the body is ignored): invitation — a PENDING organization invitation addressed to the caller’s exact verified email. When present the client must offer to JOIN that workspace instead of creating a new one; auto-creating here strands an invited teammate in an empty workspace while the real invitation sits unaccepted. Null when nobody has invited this address, and also null (fail OPEN) whenever the identity provider cannot be reached, so an outage never blocks a signup. match — the org most people on the caller’s email DOMAIN already belong to (the “your team may already be here” nudge). Null for a free-mail domain, no email, or no match. The two are independent: an invited teammate is usually the first person from their domain, so match is typically null exactly when invitation is set. Rate-limited per user.

POST

onboarding

discover

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "match": null,
    "invitation": {
      "invitationId": "orginv_2abcXYZ",
      "orgId": "org_2abcXYZ",
      "orgName": "Acme Co",
      "email": "jane@acme.com",
      "role": "staff"
    }
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json

The body is of type object.

Response

The pending invitation and/or the domain match — either may be null.

success

boolean

required

data

object

required

Show child attributes

Using the API

Endpoints

Discover the workspace that invited you, or the one your email domain belongs to

Authorizations

Body

Response