Appearance
Team API
People of an account and their role: manager (everything, incl. team and billing), member (everything but team and billing), viewer (read-only). Members and viewers can be limited to some sites.
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
| Method | Path | What it does |
|---|---|---|
| GET | /team | The people of the account, pending invitations (managers only) and the seats of the plan |
| POST | /team/invitations | Invite someone into the account (managers); the one-time link is emailed and works for 7 days |
| DELETE | /team/invitations/{invitation} | Revoke a pending invitation (managers) |
| PATCH | /team/members/{member} | Change a person's role or the sites they are limited to (managers); the last manager stays one |
| DELETE | /team/members/{member} | Remove a person from the account (managers; not yourself); their user, tokens and sessions are deleted |
GET /team
The people of the account, pending invitations (managers only) and the seats of the plan
Responses
- 200 — The team.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.members | object[] | ||
data.members[].id | integer | ||
data.members[].name | string | ||
data.members[].email | string | ||
data.members[].role | string | manager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer. | |
data.members[].site_ids | integer[], nullable | Sites the person is limited to; null = every site. | |
data.members[].me | boolean | ||
data.members[].suspended | boolean | ||
data.members[].last_login_at | string (date-time), nullable | ||
data.invitations | object[] | ||
data.invitations[].id | integer | ||
data.invitations[].email | string | ||
data.invitations[].role | string | manager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer. | |
data.invitations[].site_ids | integer[], nullable | ||
data.invitations[].invited_by | string, nullable | ||
data.invitations[].expires_at | string (date-time) | ||
data.can_manage | boolean | ||
data.seats | object | ||
data.seats.used | integer | People plus pending invitations. | |
data.seats.limit | integer, nullable |
bash
curl -X GET "https://your-site.com/api/v1/team" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /team/invitations
Invite someone into the account (managers); the one-time link is emailed and works for 7 days
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | |
role | string | yes | manager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer. |
sites | integer[] | Members and viewers only: the sites they are limited to (empty = every site). |
Responses
- 201 — Invited.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.email | string |
bash
curl -X POST "https://your-site.com/api/v1/team/invitations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"email":"[email protected]","role":"manager","sites":[1]}'DELETE /team/invitations/{invitation}
Revoke a pending invitation (managers)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
invitation | path | integer | yes |
Responses
- 204 — Revoked.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/team/invitations/{invitation}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /team/members/{member}
Change a person's role or the sites they are limited to (managers); the last manager stays one
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
member | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
role | string | manager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer. | |
sites | integer[] |
Responses
- 200 — The new access.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.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 |
bash
curl -X PATCH "https://your-site.com/api/v1/team/members/{member}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"role":"manager","sites":[1]}'DELETE /team/members/{member}
Remove a person from the account (managers; not yourself); their user, tokens and sessions are deleted
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
member | path | integer | yes |
Responses
- 204 — Removed.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
- 422 — Validation failed.
bash
curl -X DELETE "https://your-site.com/api/v1/team/members/{member}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"