Opine
  • Welcome to Opine
  • Key concepts
  • Guides
    • Getting started
      • Account setup
      • Connect your tools
      • Product tour
        • Workbench
        • Deals
        • Plans
        • Plan Templates
        • Criteria Library
        • Requests
      • Conclusion
    • How to run your first evaluation
      • Create a plan
      • Customize the plan
      • Connect Slack channels
      • Share the Plan
      • Track Plan progress
      • Use Opine AI
      • AI Document Generation
    • How to set your team up for success with the Library
      • Defining Success Criteria
      • Building your Library
      • Creating Templates
      • Creating Plays
      • Criteria Metrics
      • Conclusion
  • Security
    • SAML
  • Integrations
    • Clari
    • Gong
    • Google Calendar
    • HubSpot
    • Jira
    • Linear
    • Salesforce
    • Slack
    • Microsoft Teams
    • Zoom
  • API
    • Overview
    • API Reference
      • Deals
      • Evaluations
      • Invitations
      • Organization
      • Users
Powered by GitBook
On this page
  1. API
  2. API Reference

Invitations

Manage organization invitations

PreviousEvaluationsNextOrganization

Last updated 1 month ago

Revoke Invitation

post

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

Authorizations
Path parameters
idnumber · min: 1Required

The ID of the invitation to revoke

Responses
200
Response for status 200
application/json
500
An unknown error occurred, trying again might help.
application/json
post
POST /v1/organization/invitations/{id}/revoke HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1
}
  • GET/v1/organization/invitations
  • POSTInvite User
  • POSTRevoke Invitation
get

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

Authorizations
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
500
An unknown error occurred, trying again might help.
application/json
get
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-05-31T02:49:11.773Z",
      "updatedAt": "2025-05-31T02:49:11.773Z",
      "expiresAt": "2025-05-31T02:49:11.773Z",
      "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
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
500
An unknown error occurred, trying again might help.
application/json
post
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": "name@gmail.com",
  "role": "ADMIN"
}
{
  "status": "PENDING",
  "role": "ADMIN",
  "id": 1,
  "createdAt": "2025-05-31T02:49:11.773Z",
  "updatedAt": "2025-05-31T02:49:11.773Z",
  "expiresAt": "2025-05-31T02:49:11.773Z",
  "inviterUserId": 1,
  "inviteeEmail": "text",
  "organizationId": 1
}