Documentation

Apps

apps

Methods

Get App Settings ->
AppResponse
get/v1/apps/{app_id}

Get the settings and configuration for an app.

Get Test Credentials ->
TestAccountsResponse
get/v1/apps/{app_id}/test_credentials

Get the test accounts and credentials for an app.

Domain types

AllowlistDeletionResponse = { message }

Confirmation response for deleting an allowlist entry.

AllowlistEntry = { id, acceptedAt, appId, 2 more... }

An allowlist entry for an app.

AppResponse = { id, accent_color, allowed_domains, 53 more... }

The response for getting an app.

EmailInviteInput = { type, value }

Allowlist invite input for an email address.

PhoneInviteInput = { type, value }

Allowlist invite input for a phone number.

TestAccount = { id, created_at, email, 3 more... }

A test account for an app.

TestAccountsResponse = { data }

Response for listing test accounts for an app.

UserInviteInput =
EmailInviteInput
|
WalletInviteInput
|
PhoneInviteInput

Input for adding or removing an allowlist entry. Discriminated by type.

WalletInviteInput = { type, value }

Allowlist invite input for a wallet address.

Apps

Allowlist

apps.allowlist

Methods

List Allowlist Entries -> Array<
AllowlistEntry
>
get/v1/apps/{app_id}/allowlist

Get all allowlist entries for an app. Returns the list of users allowed to access the app when the allowlist is enabled.

Add To Allowlist ->
AllowlistEntry
post/v1/apps/{app_id}/allowlist

Add a new entry to the allowlist for an app. The allowlist must be enabled.

path Parameters
app_id: string

The ID of the app.

Response fields
AllowlistEntry
Request example
200Example
Remove From Allowlist ->
AllowlistDeletionResponse
delete/v1/apps/{app_id}/allowlist

Remove an entry from the allowlist for an app. The allowlist must be enabled.