Authentication

Search…
Authentication
GET /v1/reset-password/{id}
Description
Get password reset token.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{}
POST /v1/forgot-password/{token_id}
Description
Reset password.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{}
POST /v1/forgot-password
Description
Initiate a forgot password flow.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{}
POST /v1/sign-up/invitee/{invite_id}
Description
Accept a team invite.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{}
GET - /v1/team/invite/invite_id
Description
View an existing invite.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{}
POST /v1/sign-up/team
Description
This endpoint will a new team, new account, generic schemas and a default datalake for the new team.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Responses
200 - Account created successfully
{
    "id": "d0af3a8d-4f58-4d68-9398-d47ac7368bab",
    "name": "mark test",
    "email": "[email protected]",
    "onboarding_state": "ONBOARD",
    "onboarding_state_status": "PROCESSING",
    "team": {
        "id": "42b73c94-6666-4acd-9dda-d99a45f302d9",
        "name": "test-123"
    }
}
422 - Bad or missing value for a field
{
    "errors": [
        {
            "code": 422,
            "domain": "account",
            "field": "full_name",
            "status": "invalid",
            "raw_error": "",
            "message": "cannot be blank"
        }
    ]
}
POST /v1/logout
Description
Logs an account out of the API, invalidating the JWT token.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Responses
200 - Logged out
POST /v1/login
Description
Log into the API as an account.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Body Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Responses
200 - Successful login
{
    "id": "bc74ad96-be53-4657-a524-705545510dcc",
    "name": "mark test",
    "email": "[email protected]",
    "onboarding_state": "ONBOARD",
    "onboarding_state_status": "PROCESSING",
    "team": {
        "id": "9c3d4691-1788-46fd-a30f-8eb0b66cb5e1",
        "name": "test-1"
    }
}
Accounts
Billing
Last modified 1yr ago
Copy link
On this page
GET /v1/reset-password/{id}
POST /v1/forgot-password/{token_id}
POST /v1/forgot-password
POST /v1/sign-up/invitee/{invite_id}
GET - /v1/team/invite/invite_id
POST /v1/sign-up/team
POST /v1/logout
POST /v1/login