List invites

List the workspace's open invites, pending or expired.

GEThttps://api.tried.com.au/workspace/invites

Returns invites that have not been accepted yet, newest first. Expired invites stay in the list with status: "expired" until you delete them. Admin only.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/workspace/invites \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/workspace/invites", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const invites = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/workspace/invites",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
invites = res.json()

Response#

200 OK

[
  {
    "invite_id": "invite_4a6c8e0b2d4f6a8c0e2b4d6f",
    "email": "jordan@harbourdental.com.au",
    "role": "member",
    "accept_path": "/invite/Qm3xT9vLr2Kp8sWd5ZyB1nHc7GfJ0aEu",
    "token": "Qm3xT9vLr2Kp8sWd5ZyB1nHc7GfJ0aEu",
    "status": "pending",
    "expires_timestamp": 1762041600000,
    "created_timestamp": 1760832000000
  }
]

An array of invites.

Field	Type	Description
`invite_id`	string	Invite ID, prefix `invite_`.
`email`	string	Invitee email, lowercased.
`role`	string	Role the invitee gets on accept: `admin`, `developer` or `member`.
`accept_path`	string	Dashboard path that accepts the invite: `/invite/<token>`. Prefix it with your dashboard URL.
`token`	string	Invite token.
`status`	string	`pending` or `expired`. Accepted invites are not listed.
`expires_timestamp`	integer	Expiry, Unix ms. Invites last 14 days.
`created_timestamp`	integer	Creation time, Unix ms.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope. A dashboard user without the right role gets `Requires role: admin`. API keys act as admin.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.