Show a signup in progress

View .md OpenAPI spec Open in Claude Open in ChatGPT

GET

/v1/signup

const url = 'https://app.caprid.com/v1/signup';
const options = {method: 'GET'};

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://app.caprid.com/v1/signup

Only with WorkOS login. After a first sign-in, the person has proved who they are but has no Account yet. This route returns the email WorkOS verified, so the dashboard can ask for a Namespace. It also lists the pending Invitations to that email, so the dashboard can offer to join one of those Organizations instead. The login callback sets a cookie that holds the signup in progress for 15 minutes.

Responses

200

The signup in progress.

application/json

object

email

required

string format: email

invitations

required

Array<object>

An offer of membership in an Organization to one email address.

object

required

Identifies the Invitation in routes. Not a secret.

string

organization_id

required

integer

organization_name

The Organization’s name, for someone who isn’t in it yet.

string

email

required

Who may accept it. Stored lowercased.

string

role

required

The role they’ll have once they accept.

string

Allowed values: owner member

created_at

required

integer

expires_at

required

When the link stops working, 7 days after it was created.

integer

Example

{
  "email": "alice@acme.example",
  "invitations": [
    {
      "id": "3f9c1a2b7d4e",
      "organization_id": 4,
      "organization_name": "Acme",
      "email": "alice@acme.example",
      "role": "member",
      "created_at": 1790294400,
      "expires_at": 1790899200
    }
  ]
}

404

No signup is in progress, or this server doesn’t use WorkOS login.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}