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

Evaluations

Manage evaluations

PreviousDealsNextInvitations

Last updated 1 month ago

List Evaluations

get

List evaluations. Requires the 'evaluations: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
Responses
200
Response for status 200
application/json
500
An unknown error occurred, trying again might help.
application/json
get
GET /v1/evaluations HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "items": [
    {
      "id": 1,
      "createdAt": "2025-05-31T18:15:55.664Z",
      "updatedAt": "2025-05-31T18:15:55.664Z",
      "title": "text",
      "description": "text",
      "active": true,
      "organizationId": 1,
      "createdByUserId": 1,
      "accessCode": "123e4567-e89b-12d3-a456-426614174000",
      "brandingColorHex": "text",
      "startDate": "2025-05-31T18:15:55.664Z",
      "targetEndDate": "2025-05-31T18:15:55.664Z",
      "buyerNotificationsEnabled": true,
      "currentStageId": 1,
      "derivedFromTemplateId": 1
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}