Setting Up an Account

Steps

1. Sign up

To get started, sign up for a SideDrawer Account. You will be prompted to enter your email address and create a password (or use a different sign-on method), and authenticate your identity with MFA.

2. Create Account

Next, create an Account.

POST /api/v1/users/accounts

{
    "username": "[email protected]",
    "firstName": "Jane",
    "lastName": "Smith",
    "primaryResidence": {
        "country": "Canada"
    },
    "emails": [
        {
            "primary": true,
            "verified": false,
            "address": "[email protected]"
        }
    ],
    "settings": {
        "notificationMethod": "email",
        "communicationLanguage": "en-CA",
        "country": "CA",
        "preferredLanguage": "en-CA",
        "mfaDisabled": true,
        "mfaMode": "never",
        "idpMfa": "never"
    },
    "agreements": [
        {
            "locale": "en-CA",
            "type": "tos",
            "version": 0,
            "consent": true
        },
        {
            "locale": "en-CA",
            "type": "privacy_policies",
            "version": 0,
            "consent": true
        }
    ],
    "openId": "auth0|12345abcde",
    "dataBaseRegion": "",
    "brandCodeAffiliations": [
        "sidedrawer"
    ],
    "identityProvider": "auth0"
}

{
  "id": "{accountId}"
}

2. Get Teams

Display the Teams you currently belong to.

GET /api/v1/networks/network/my-teams

3. Get settings

Get your Account settings.

GET /api/v1/users/accounts/account-id/{accountId}/settings

4. Get Drawers

List the Drawers (sidedrawer) you own and those that are shared with you.

Get owned Drawers (sidedrawer)

GET /api/v2/networks/sidedrawer/owned

Get shared Drawers (sidedrawer)

GET /api/v2/networks/sidedrawer/shared

5. Go to "home"

Get to your home page.

GET /api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/home

6. Get Plan Requests

List your created Plan Requests.

GET /api/v1/plan-requests/sidedrawer/sidedrawer-id/{sidedrawerId}/plan-requests

7. Get Filing Cabinets

List the Filing Cabinets you belong to.

GET /api/v1/users/accounts/account-id/{accountId}/filing-cabinets

8. Get Folders

Find the Folders (records) you have.

GET /api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records

9. Get branding

Get the branding details for your Drawer (sidedrawer).

GET /api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/branding

And that's it! You have created a SideDrawer Account and run through the basic endpoints that are called by the system upon sign-in.