Steps
You'll need:
- an access token
- a SideDrawer Account
1. Get region
Identify the available database regions.
GET/api/v1/configs/content/collections/{slug}/locale/{locale}
2. Owned Drawers
Find your "owned" Drawers (sidedrawer) across all regions.
GET/api/v2/networks/sidedrawer/owned{ "data": [ { "name": "My Drawer", "brandName": "", "sdRole": "sd_owner", "default": false, "sdPhoto": "", "id": "{sidedrawerId}", "networkId": "{networkId}", "plan": { "id": "{planId}" } } ], "hasMore": false, "nextPage": null, "previousPage": null, "totalCount": 1 }
3. Shared Drawers
Find the Drawers (sidedrawer) shared with you across all regions.
GET/api/v2/networks/sidedrawer/shared{ "data": [ { "name": "My Drawer", "brandName": "", "sdRole": "sd_editor", "default": false, "id": "{sidedrawerId}", "networkId": "{networkId}", "plan": { "id": "{planId}" } }, { "name": "Another Drawer", "brandName": "", "sdRole": "rec_editor", "default": false, "sdPhoto": "", "id": "{sidedrawerId}", "networkId": "{networkId}", "expiryDate": "2024-07-23T14:59:01.270Z", "plan": { "id": "{planId}" } } ], "hasMore": false, "nextPage": null, "previousPage": null, "totalCount": 2 }
4. Choose Drawer
Identify the latest or default Drawer (sidedrawer) in those lists.
5. Home
Invoke the "home" endpoint for that Drawer (sidedrawer).
GET/api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/home?{ "locale": "en-CA" }{ "id": "{sidedrawerId}", "name": "My Drawer", "default": false, "active": true, "status": "ACTIVE", "type": "individual", "userSidedrawerRole": [ "sd_owner" ], "subscriptionFeatures": { "account.featureAddOn": "0", "account.guest.record.editor": "1", "account.guest.record.info": "1", "account.guest.record.viewer": "1", "account.guest.sd.editor": "1", "account.guest.sd.info": "1", "account.guest.sd.viewer": "1", "account.licensePriority": "3090", "account.sponsorSideDrawers": "1", "product.audience": "users", "product.cancelPeriodEnd": "0", "product.disabled": "0", "product.display": "1", "product.startingSideDrawers": "1000", "product.startingUsers": "5", "product.trial": "1", "sidedrawer.any.sd.featureInbox": "1", "sidedrawer.guest.any.notifications": "0", "sidedrawer.guest.record.editor": "1", "sidedrawer.guest.record.info": "1", "sidedrawer.guest.record.viewer": "1", "sidedrawer.guest.sd.editor": "1", "sidedrawer.guest.sd.info": "1", "sidedrawer.guest.sd.viewer": "1", "sidedrawer.maxSDGBs": "6", "sidedrawer.maxSDRecords": "240", "sidedrawer.maxUploadMBs": "50", "sidedrawer.owned.any.notifications": "1", "sidedrawer.owned.sd.deleteSD": "0", "sidedrawer.owned.sd.multipleOwners": "1", "sidedrawer.owned.sd.transferOwnership": "1" }, "maxRecordsReached": false, "sidedrawernotificationsDisabled": false, "externalKeys": [], "integrations": [], "cobrandId": "", "recordsType": [ { "name": "myFolder", "logo": "", "count": 1, "displayValue": [ { "locale": "en-CA", "value": "My Folder", "description": "" } ] } ], "owners": [ { "_id": "{ownerId}", "openId": "auth0|ababab", "username": "[email protected]", "firstName": "Jane", "lastName": "Smith", "profilePhoto": "", "brandCodeAffiliations": [ "" ], "tenant": null, "active": true, "identityProvider": "auth0", "customerId": "{customerId}", "createdAt": "2024-07-23T13:45:14.398Z", "updatedAt": "2024-08-09T14:12:18.077Z", "__v": 0, "lastLogin": "2024-08-09T14:12:17.000Z" } ] }
6. Get Folders
Get all Folders (record).
GET/api/v2/records/sidedrawer/sidedrawer-id/{sidedrawerId}/records{ "locale": "en-CA", "uniqueReference": "" }{ "data": [], "hasMore": false, "nextPage": null, "previousPage": null, "totalCount": 0 }
7. Get branding
Get the branding information.
GET/api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}/branding{ "locale": "en-CA", "darkMode": "lightMode" }{ "id": "{id}", "brandCode": "{brandCode}", "tenant": "{tenantId}", "brandName": "Brand", "primaryLogoExpanded": { "large": "{logo url}", "medium": "{logo url}", "small": "{logo url}" }, "primaryLogoContracted": { "large": "{logo url}", "medium": "{logo url}", "small": "{logo url}" }, "secondaryLogo": { "large": "{logo url}", "medium": "{logo url}", "small": "{logo url}" }, "primaryIsoLogo": { "large": "{logo url}", "medium": "{logo url}", "small": "{logo url}" }, "secondaryIsoLogo": { "large": "{logo url}", "medium": "{logo url}", "small": "{logo url}" }, "topBanner": { "large": "{logo url}", "medium": "{logo url}", "small": "{logo url}" }, "emailHeaderBanner": {}, "footerMessage": "Message", "styleSheet": { "fontFamily": "Arial", "appBackground": "#FFFFFF", "primaryColor": "#FFFFFF", "primaryAccentColor": "#FFFFFF", "primaryColorSemiTransparent": "#FFFFFF", "secondaryAccentColor": "#FFFFFF", "tertiaryAccentColor": "#FFFFFF", "backgroundShade": "#FFFFFF", "accentBackground": "#FFFFFF", "headerBackground": "#FFFFFF", "inactiveButton": "#FFFFFF", "alertsErrors": "#FFFFFF", "checkbox": "#FFFFFF", "progressBar": "#FFFFFF", "appCameraBackground": "#FFFFFF", "successBar": "#FFFFFF" }, "appSections": { "tellAFriend": true, "faqs": true, "manageSubscriptions": true, "about": true, "helpAndSupport": true, "paymentDetails": true }, "socialLogin": true, "socialIdps": [ "google-oauth2", "apple", "salesforce", "facebook" ], "active": true, "bypassSDCreation": true, "webAppRoot": "{sidedrawerurl}", "hideDefaultRecordTypes": false, "skipSponsorEditorAssignment": false, "exclusiveBrandRecordTypesOnly": false, "metadata": {}, "default": true, "forceSDCreation": false, "hideChatBubble": false, "hideTeamMembers": false, "hideSummary": false, "hideRequests": false, "simplifiedRecordView": false, "hideReminders": false, "locale": "en-CA" }