Invitations

Manage organization invitations

get

List organization invitations. Requires the 'invitations:read' scope.

Authorizations
X-API-KeystringRequired

API key for authentication

Query parameters
limitnumber · min: 1 · max: 1000Optional

The number of results to return

Default: 100
offsetnumberOptional

The number of results to skip

Default: 0
statusstring · enumOptional

The status of the invitations to list

Possible values:
includeExpiredbooleanOptional

Whether to include expired invitations in the list

Default: false
Responses
200

Response for status 200

application/json
get
/v1/organization/invitations
GET /v1/organization/invitations HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "status": "PENDING",
      "role": "ADMIN",
      "id": 1,
      "createdAt": "2025-12-06T14:43:11.953Z",
      "updatedAt": "2025-12-06T14:43:11.953Z",
      "expiresAt": "2025-12-06T14:43:11.953Z",
      "inviterUserId": 1,
      "inviteeEmail": "text",
      "organizationId": 1
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

Invite User

post

Invite a user to join an organization. Requires the 'invitations:write' scope.

Authorizations
X-API-KeystringRequired

API key for authentication

Body
inviteeEmailstring · emailRequired

The email of the user to invite

rolestring · enumRequired

The role of the user to invite

Possible values:
Responses
200

Response for status 200

application/json
post
/v1/organization/invitations
POST /v1/organization/invitations HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "inviteeEmail": "[email protected]",
  "role": "ADMIN"
}
{
  "status": "PENDING",
  "role": "ADMIN",
  "id": 1,
  "createdAt": "2025-12-06T14:43:11.953Z",
  "updatedAt": "2025-12-06T14:43:11.953Z",
  "expiresAt": "2025-12-06T14:43:11.953Z",
  "inviterUserId": 1,
  "inviteeEmail": "text",
  "organizationId": 1
}

Revoke Invitation

post

Revoke an invitation to join an organization. Requires the 'invitations:write' scope.

Authorizations
X-API-KeystringRequired

API key for authentication

Path parameters
idnumber · min: 1Required

The ID of the invitation to revoke

Responses
200

Response for status 200

application/json
post
/v1/organization/invitations/{id}/revoke
POST /v1/organization/invitations/{id}/revoke HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1
}
PreviousEvaluationsNextOrganization

Last updated