Skip to content

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.

MethodPathWhat it does
GET/teamThe people of the account, pending invitations (managers only) and the seats of the plan
POST/team/invitationsInvite 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
FieldTypeRequiredDescription
dataobject
data.membersobject[]
data.members[].idinteger
data.members[].namestring
data.members[].emailstring
data.members[].rolestringmanager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer.
data.members[].site_idsinteger[], nullableSites the person is limited to; null = every site.
data.members[].meboolean
data.members[].suspendedboolean
data.members[].last_login_atstring (date-time), nullable
data.invitationsobject[]
data.invitations[].idinteger
data.invitations[].emailstring
data.invitations[].rolestringmanager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer.
data.invitations[].site_idsinteger[], nullable
data.invitations[].invited_bystring, nullable
data.invitations[].expires_atstring (date-time)
data.can_manageboolean
data.seatsobject
data.seats.usedintegerPeople plus pending invitations.
data.seats.limitinteger, 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

FieldTypeRequiredDescription
emailstring (email)yes
rolestringyesmanager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer.
sitesinteger[]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
FieldTypeRequiredDescription
dataobject
data.idinteger
data.emailstring
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 ​

NameInTypeRequiredDescription
invitationpathintegeryes

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 ​

NameInTypeRequiredDescription
memberpathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
rolestringmanager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer.
sitesinteger[]

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
FieldTypeRequiredDescription
dataobject
data.idinteger
data.rolestringmanager: everything incl. team and billing; member: everything but team and billing; viewer: read-only. One of: manager, member, viewer.
data.site_idsinteger[], 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 ​

NameInTypeRequiredDescription
memberpathintegeryes

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"

Replora: see what your visitors see.