login

Exchange an email and password for a token used for future requests. This endpoint can be used by admin or participant accounts. If you're logging in a participant, an organisationUuid must be present in the body.

For custom components:

RaiselyComponents.api.all('login').post(data = {}, params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The email address of the account to authenticate.

string
required

The password of the account to authenticate.

boolean

By default admins are logged in only with normal participant privileges. Set this to true to get a token that grants full privileges.

string

OTP password to complete 2FA login

boolean

Force an SMS OTP token to be sent even if the user is enrolled in Authy

string

The UUID of the organisation the user is being logged in for. Required to login non-admin users

Headers
string

A valid HTTP Bearer token, required to access private records.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json