Skip to content

API reference

Sign-in and account

8 operations, each with its parameters, curl and TypeScript examples ready to copy, and its errors.

Every example assumes a signed-in session; how to get one is in Authentication

signIn

POST/api/ins/sign

No sessionPermission: auth:anonymous

signIn

Parameters of signIn
NameInTypeRequired
codeBodystring 0–64No
emailBodystring 1–320Yes
nextBodystring 0–2048No
passwordBodystring 1–1024Yes
curl
curl -X POST 'https://www.notificado.co/api/ins/sign' \
  -H 'content-type: application/json' \
  -d '{"email":"<email>","password":"<password>"}'
TypeScript
const response = await fetch('https://www.notificado.co/api/ins/sign', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "email": "<email>",
    "password": "<password>"
  }),
});
const result = await response.json();
Example response
200
{
  "ok": true,
  "userId": "<userId>"
}

Errors

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

unsubscribeOnboarding

POST/api/onboardings/unsubscribe

Firm memberPermission: growth:unsubscribe-link

unsubscribeOnboarding

Parameters of unsubscribeOnboarding
NameInTypeRequired
List-UnsubscribeBodystring 1–32No
tBodystring 1–512No
curl
curl -X POST 'https://www.notificado.co/api/onboardings/unsubscribe' \
  -b cookies.txt \
  -H 'origin: https://www.notificado.co' \
  -H 'content-type: application/json' \
  -d '{}'
TypeScript
const response = await fetch('https://www.notificado.co/api/onboardings/unsubscribe', {
  method: 'POST',
  headers: { 'content-type': 'application/json', origin: 'https://www.notificado.co', cookie: sessionCookie },
  body: JSON.stringify({}),
});
const result = await response.json();
Example response
200
{
  "ok": true
}

Errors

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

signOut

POST/api/outs/sign

Firm memberPermission: auth:sign-out

signOut

curl
curl -X POST 'https://www.notificado.co/api/outs/sign' \
  -b cookies.txt \
  -H 'origin: https://www.notificado.co' \
  -H 'content-type: application/json' \
  -d '{}'
TypeScript
const response = await fetch('https://www.notificado.co/api/outs/sign', {
  method: 'POST',
  headers: { 'content-type': 'application/json', origin: 'https://www.notificado.co', cookie: sessionCookie },
  body: JSON.stringify({}),
});
const result = await response.json();
Example response
200
{
  "ok": true
}

Errors

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

requestPasswordReset

POST/api/password-resets/request

No sessionPermission: auth:anonymous

requestPasswordReset

Parameters of requestPasswordReset
NameInTypeRequired
captchaTokenBodystring 0–4096No
cf-turnstile-responseBodystring 0–4096No
emailBodystring 0–320Yes
h-captcha-responseBodystring 0–4096No
localeBodystring 0–16No
curl
curl -X POST 'https://www.notificado.co/api/password-resets/request' \
  -H 'content-type: application/json' \
  -d '{"email":"<email>"}'
TypeScript
const response = await fetch('https://www.notificado.co/api/password-resets/request', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "email": "<email>"
  }),
});
const result = await response.json();
Example response
200
{
  "ok": true
}

Errors

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

resetPassword

POST/api/passwords/reset

No sessionPermission: auth:anonymous

resetPassword

Parameters of resetPassword
NameInTypeRequired
passwordBodystring 0–1024Yes
passwordConfirmBodystring 0–1024No
tokenBodystring 0–2048Yes
curl
curl -X POST 'https://www.notificado.co/api/passwords/reset' \
  -H 'content-type: application/json' \
  -d '{"password":"<password>","token":"<token>"}'
TypeScript
const response = await fetch('https://www.notificado.co/api/passwords/reset', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "password": "<password>",
    "token": "<token>"
  }),
});
const result = await response.json();
Example response
200
{
  "ok": true
}

Errors

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

signUp

POST/api/ups/sign

No sessionPermission: auth:anonymous

signUp

Parameters of signUp
NameInTypeRequired
captchaTokenBodystring 0–4096No
cf-turnstile-responseBodystring 0–4096No
emailBodystring 1–320Yes
h-captcha-responseBodystring 0–4096No
nameBodystring 1–200Yes
nextBodystring 0–2048No
orgNameBodystring 1–200Yes
passwordBodystring 1–1024Yes
referralCodeBodystring 0–40No
termsVersionBodystring 1–64No
curl
curl -X POST 'https://www.notificado.co/api/ups/sign' \
  -H 'content-type: application/json' \
  -d '{
  "email": "<email>",
  "name": "<name>",
  "orgName": "<orgName>",
  "password": "<password>"
}'
TypeScript
const response = await fetch('https://www.notificado.co/api/ups/sign', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "email": "<email>",
    "name": "<name>",
    "orgName": "<orgName>",
    "password": "<password>"
  }),
});
const result = await response.json();
Example response
200
{
  "ok": true,
  "orgId": "<orgId>",
  "userId": "<userId>"
}

Errors

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID