Skip to main content
Quick Start

Getting started

Create a RestWard account, sign in, and pick the organization workspace you will build APIs in.

Welcome to RestWard. This guide walks you through creating an account and accessing your first organization workspace.

Creating your account

To get started, you'll need to create a RestWard account. You can use either the registration page or a sign-up link.

  1. Navigate to the registration page (or follow an invite link if you received one)
  2. Fill in your details:
    • Display Name - Your name as it appears in the workspace
    • Email - Your email address (required for login)
    • Password - A password of at least 8 characters
    • Confirm Password - Re-enter your password to verify it matches
  3. Click the Create Account button
  4. Your account is now created and you'll proceed to the next step

If you followed an invitation, you join that organization. If it requires single sign-on, no account is created: the page tells you to sign in with SSO instead, and SSO sign-in accepts your invitation.

Creating your organization

If you signed up without an invitation, you create your own organization next:

  1. Enter the Organization Name. A slug is suggested from it.
  2. Adjust the Organization Slug if you like: 3–50 lowercase letters, digits and hyphens, not starting or ending with a hyphen. Some names (such as admin, api or restward) are reserved, and every slug must be unique.
  3. Click Create Organization

You become the organization's Administrator, it starts a 30-day trial with the Starter limits in full, and you are taken straight into its workspace. Each account can create one organization this way. To join more organizations, ask their administrators to invite you.

Your first login

After creating your account, you're automatically logged in. If you joined an organization through an invitation, you're guided to select your organization.

If you're logging in later, visit the login page and:

  1. Enter your Email (the address you used to create your account)
  2. Enter your Password
  3. Click Sign In

You'll be taken to your organization selection screen.

Selecting an organization

If you have access to only one organization, you'll be taken directly to your workspace.

If you have access to multiple organizations:

  1. You'll see a list of organization cards
  2. Each card shows the organization name and your role (like "Admin" or "Member")
  3. Click the organization you want to access
  4. You'll be taken to that organization's workspace

When your access is pending

If you were invited to an organization but don't yet have an admin's approval, you'll see a "Pending approval" screen when you sign in.

On this screen:

  • Pending organizations appear in an amber card with a "Pending approval" label
  • Already approved organizations (if any) appear in a separate section below, ready to click
  • Click Check again to refresh your approval status without leaving the page
  • When an admin approves your request, you can click your organization card to access the workspace

If you have multiple pending requests, you can check back anytime. You'll see your status update as soon as an admin approves each request.

Next steps

Once you're in your workspace, you can:

  • Manage your account security and add passkeys
  • Switch between organizations (if you have access to multiple)
  • Start working with your databases and REST APIs

If you need to sign in with a different authentication method or set up a passkey for password-free login, those guides have step-by-step instructions.

Reconnecting to server...

Please wait while we restore your connection

Connection lost

Retrying in seconds...

Unable to reconnect

The server connection has been lost.
You may need to log in again.

Session Paused

The server has temporarily paused your session.

Session Expired

Your session could not be resumed.
Please reload the page to continue.