Appearance
Account API
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
POST /auth/forgot-password
Emails a link to choose a new password (6 per minute)
The answer is the same whether or not an account exists, and the email is sent after the answer, so neither tells whether the address has an account. The link opens /reset-password/{token}?email=… and works once, for 60 minutes.
No sign-in needed
This endpoint is public.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | |
recaptcha | string | While reCAPTCHA is on: a token for action "forgot_password"; otherwise a 422 on "recaptcha". |
Responses
- 200 — Always the same message.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
message | string |
bash
curl -X POST "https://your-site.com/api/v1/auth/forgot-password" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"email":"[email protected]","recaptcha":"text"}'POST /auth/reset-password
Sets a new password with the token from the emailed link (6 per minute)
Signs the account out everywhere and revokes every API token. 422 on token for an invalid, used or expired link.
No sign-in needed
This endpoint is public.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | |
email | string (email) | yes | |
password | string (password) | yes | At least 10 characters. |
password_confirmation | string (password) | yes |
Responses
- 200 — Changed.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
message | string |
bash
curl -X POST "https://your-site.com/api/v1/auth/reset-password" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"token":"text","email":"[email protected]","password":"text","password_confirmation":"text"}'GET /me
The signed-in person
Responses
- 200 — The user.
- 401 — Not signed in.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.email | string | ||
data.email_verified | boolean | Whether the address is confirmed (SaaS sign-ups confirm it by email before they can add a website). | |
data.locale | string, nullable | Interface language chosen by the person (null = the browser's) | |
data.timezone | string, nullable | Time zone the dashboard shows dates in (IANA name such as Europe/Berlin; null = the browser's) | |
data.preferences | object | The person's own preferences that follow them to every browser (e.g. replay.cursor, replay.trail). | |
data.is_admin | boolean | ||
data.account_role | string | manager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer. | |
data.site_ids | integer[], nullable | Sites the person is limited to; null = every site. | |
data.organization | object, nullable | ||
data.organization.id | integer | ||
data.organization.name | string |
bash
curl -X GET "https://your-site.com/api/v1/me" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /me
Change name, email or interface language
The language (locale) is used by the dashboard on every device and for server messages and emails. Null = the browser's.
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ||
email | string (email) | ||
locale | string, nullable | One of: en, es, fr, de, pt, it, ru, zh, ja, ko, tr, id, ar, null. | |
timezone | string, nullable | IANA time zone name, e.g. Asia/Almaty; null = the browser's | |
preferences | object | Merged into the stored preferences; null removes a key. Keys: lowercase, up to 40 characters (e.g. replay.cursor, replay.trail); values: text up to 100 characters, a number or true/false. |
Responses
- 200 — The user.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.email | string | ||
data.email_verified | boolean | Whether the address is confirmed (SaaS sign-ups confirm it by email before they can add a website). | |
data.locale | string, nullable | Interface language chosen by the person (null = the browser's) | |
data.timezone | string, nullable | Time zone the dashboard shows dates in (IANA name such as Europe/Berlin; null = the browser's) | |
data.preferences | object | The person's own preferences that follow them to every browser (e.g. replay.cursor, replay.trail). | |
data.is_admin | boolean | ||
data.account_role | string | manager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer. | |
data.site_ids | integer[], nullable | Sites the person is limited to; null = every site. | |
data.organization | object, nullable | ||
data.organization.id | integer | ||
data.organization.name | string |
bash
curl -X PATCH "https://your-site.com/api/v1/me" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","email":"[email protected]","locale":"en","timezone":"text","preferences":{}}'DELETE /me
Delete your own account
Needs the current password. Refused (422) for the installation's last administrator and for the last manager of a team with other members. When nobody else is in the account, the account, its sites and recordings are deleted too, its paid subscription cancelled first.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
password | string | yes |
Responses
- 204 — Deleted.
- 422 — Validation failed.
bash
curl -X DELETE "https://your-site.com/api/v1/me" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"password":"text"}'GET /account
The account's settings
Responses
- 200 — OK
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.name | string | ||
data.strict_ip | boolean | Visitor IP addresses keep only their first two parts (IPv6: the first 32 bits). |
bash
curl -X GET "https://your-site.com/api/v1/account" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /account
Change the account's settings (managers)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | At most 120 characters. | |
strict_ip | boolean |
Responses
- 200 — The settings now.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
- 422 — Validation failed.
bash
curl -X PATCH "https://your-site.com/api/v1/account" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","strict_ip":true}'GET /me/export
Download my data (a JSON file of everything kept about you; never secrets)
profile, account, sign_in (two-factor, linked Google address, API tokens without their values) and one section per installed module (e.g. sites, plan). Dashboard or full-access token only; 6 a minute.
Responses
- 200 — The file (Content-Disposition: attachment; filename="my-data-<date>.json").
- 403 — A limited token.
bash
curl -X GET "https://your-site.com/api/v1/me/export" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /account/dpa
The account's Data Processing Agreement (SaaS) - whether one is published, and who accepted which version when
Responses
- 200 — data: {available, url, version (the page's last change), accepted: {at, name, email, version, current} or null, can_accept (managers)}
- 404 — The person has no account.
bash
curl -X GET "https://your-site.com/api/v1/account/dpa" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /account/dpa
Accept the published Data Processing Agreement for the account (its managers)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
accept | boolean | yes | One of: true. |
Responses
- 200 — The new state, as GET.
- 403 — Not a manager of the account.
- 409 — No Data Processing Agreement is published.
bash
curl -X POST "https://your-site.com/api/v1/account/dpa" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"accept":true}'GET /me/google
Your linked Google account (linking is the browser round trip GET /auth/google/connect)
Responses
- 200 — data:
bash
curl -X GET "https://your-site.com/api/v1/me/google" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"DELETE /me/google
Disconnect Google (the account then signs in with its password)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | yes |
Responses
- 200 — The new link status.
- 422 — Wrong password.
bash
curl -X DELETE "https://your-site.com/api/v1/me/google" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"current_password":"text"}'GET /me/two-factor
Your two-factor sign-in status
Responses
- 200 — data:
bash
curl -X GET "https://your-site.com/api/v1/me/two-factor" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /me/two-factor
Start setting up two-factor sign-in (answers the secret and otpauth address once)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | yes |
Responses
- 200 — data:
- 409 — It is on already.
- 422 — Wrong password.
bash
curl -X POST "https://your-site.com/api/v1/me/two-factor" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"current_password":"text"}'DELETE /me/two-factor
Turn two-factor sign-in off
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | yes |
Responses
- 200 — The new status.
- 422 — Wrong password.
bash
curl -X DELETE "https://your-site.com/api/v1/me/two-factor" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"current_password":"text"}'POST /me/two-factor/confirm
Turn two-factor sign-in on with the first code (answers the 10 recovery codes once)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | At most 20 characters. |
Responses
- 200 — data:
- 422 — Wrong code, or set-up not started.
bash
curl -X POST "https://your-site.com/api/v1/me/two-factor/confirm" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"code":"text"}'POST /me/two-factor/recovery-codes
New recovery codes (the old ones stop working)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | yes |
Responses
- 200 — data:
- 409 — Two-factor sign-in is off.
- 422 — Wrong password.
bash
curl -X POST "https://your-site.com/api/v1/me/two-factor/recovery-codes" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"current_password":"text"}'PUT /me/password
Change the password
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | yes | |
password | string | yes | At least 8 characters. |
password_confirmation | string | yes |
Responses
- 204 — Changed.
- 422 — Validation failed.
bash
curl -X PUT "https://your-site.com/api/v1/me/password" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"current_password":"text","password":"text","password_confirmation":"text"}'GET /tokens
The person's tokens (signed-in devices and script keys)
Responses
- 200 — Tokens, newest first;
currentmarks the one making this request.meta.abilitieslists the abilities a new token can have.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].name | string | ||
data[].abilities | string[] | ||
data[].last_used_at | string (date-time), nullable | ||
data[].expires_at | string (date-time), nullable | ||
data[].created_at | string (date-time) | ||
data[].current | boolean | ||
meta | object | ||
meta.abilities | object |
bash
curl -X GET "https://your-site.com/api/v1/tokens" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /tokens
Create a token (the secret is returned once)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
abilities | string[] | yes | |
expires_in_days | integer, nullable | Minimum 1. Maximum 3650. | |
password | string (password) | yes | The person's password: confirms it's them before a new key to the account is created. |
Responses
- 201 — Created.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
token | string |
bash
curl -X POST "https://your-site.com/api/v1/tokens" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","abilities":["recordings:read"],"expires_in_days":1,"password":"text"}'DELETE /tokens/{token}
Revoke one of the person's tokens
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
token | path | integer | yes |
Responses
- 204 — Revoked.
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/tokens/{token}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /company
Who runs this installation (administrators; the public website's legal pages and contact links use it)
Responses
- 200 — OK
- 403 — Not an installation administrator.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.name | string | ||
data.country | string | ||
data.address | string | ||
data.email | string | ||
data.refund_days | integer |
bash
curl -X GET "https://your-site.com/api/v1/company" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /company
Saves the company details (fields left out keep their value)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | At most 200 characters. | |
country | string | At most 100 characters. | |
address | string | At most 400 characters. | |
email | string (email) | ||
refund_days | integer | Minimum 0. Maximum 365. |
Responses
- 200 — OK
- 403 — Not an installation administrator.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.name | string | ||
data.country | string | ||
data.address | string | ||
data.email | string | ||
data.refund_days | integer |
bash
curl -X PUT "https://your-site.com/api/v1/company" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","country":"text","address":"text","email":"[email protected]","refund_days":0}'GET /settings/installation
Installation settings (administrators) — every group the core and the modules declare, with current values
Secrets (type secret) never come back; set says whether one is stored. Stored values win over .env.
Responses
- 200 — data: [{id, title, description, fields: [{key, type, label, hint, options, min, max, max_length, value, set}]}]
- 403 — Not an installation administrator.
bash
curl -X GET "https://your-site.com/api/v1/settings/installation" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /settings/installation
Saves installation settings
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
values | object | yes | Setting key (a config path) => value; a secret sent as null or empty is kept. |
remove | string[] | Keys of secrets to remove. |
Responses
- 200 — Like GET.
- 403 — Not an installation administrator.
- 422 — Errors keyed by setting key.
bash
curl -X PUT "https://your-site.com/api/v1/settings/installation" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"values":{},"remove":["text"]}'POST /settings/installation/mail-test
Sends a test email to the administrator with the current email settings
Responses
- 200 — data.sent_to
- 403 — Not an installation administrator.
- 422 — errors.mail: the mail server's answer.
bash
curl -X POST "https://your-site.com/api/v1/settings/installation/mail-test" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"