Harthelm Docs
REST APIInvites

List an organization's invitations

Organization owners (`org.members`). Pending first; closed ones (accepted, revoked, expired) only with `include_closed`.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/orgs/{org}/invites

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Path Parameters

org*string
Formatuuid

Query Parameters

include_closed?boolean

Also list accepted, revoked and expired invitations.

Defaultfalse
limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024

Response Body

A page of invitations.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/invites'
{  "next_cursor": "string",  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",      "org_name": "string",      "team_id": 1,      "team_name": "string",      "role": "owner",      "invited_by": {        "id": 1,        "name": "string",        "email": "string",        "picture_url": "string"      },      "state": "pending",      "mail": "off",      "created_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "accepted_at": "2019-08-24T14:15:22Z"    }  ]}

Pending invitations for the caller

Pending invitations whose email is the caller's verified email. They are accepted automatically at the next sign-in; the console offers *Accept* and *Decline* before that. Empty when the caller's email is not verified or the issuer's `email_verified` is not trusted.

List a team's invitations

Team admins (`team.members`). Pending first; closed ones only with `include_closed`.