Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Dialer SDK
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Dialer SDK
  1. Scorecards
  • Platform
    • Users
      • List Users
      • Create User
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
    • Groups
      • Get Group Tree
      • List Child Groups
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • Create Webhook
      • Get Webhook Details
      • List Webhooks
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
    • Media Prompts
      • List Prompts
      • Get Prompt by ID
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Get Agent Details
      GET
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
      • Email Call Data
      • Move Call to Another Group
      • Add Notes to Calls
      • Upload Call Recording
      • Add Tags to Call
    • SMS
      • Get SMS Conversations
      • Get SMS Conversation By ID
    • Opportunity Recovery
      • Get Conversations By Custom Insights
    • Agent Performance
      • Get Agent Performance Metrics
    • Attribution Engine
      • Get Marketing Attribution Data
  • Blacklist
    • List blacklisted numbers
    • Add numbers to blacklist
    • Delete numbers from blacklist
  • Call Action Templates
    • Create Call Action Template
    • Update Call Action Template
  • Campaigns
    • List Campaigns
    • Create Campaign
    • Get Campaign Details
    • Update Campaign
    • Partial Update Campaign
    • Delete Campaign
  • Custom Insights
    • Get Custom Insights
    • Create New Custom Insight
    • Get Custom Insight By Id
    • Update Custom Insight
    • Partial Update Custom Insight
    • Delete Custom Insight
  • Custom Source
    • Get Custom Sources
    • Create Custom Source
    • Delete Custom Sources (Single or Multiple)
  • DNI
    • List DNI Settings
    • Update DNI Setting
    • Delete DNI Setting
    • Create DNI Setting
  • Geo Locations
    • List Geo Locations
    • Create Geo Location
    • Get Geo Location
    • Update Geo Location
    • Partially Update Geo Location
    • Delete Geo Location
    • List Geo Location Routes
    • Create Geo Location Route
    • Get Geo Location Route
    • Update Geo Location Route
    • Partially Update Geo Location Route
    • Delete Geo Location Route
    • Import Geo Location Routes from CSV
  • Insights
    • List Insights
    • Create Insight
    • Get Insight Details
    • Delete Insight
  • Scorecards
    • List Scorecards
      GET
    • Get Scored Calls Report
      GET
    • Create Scorecard
      POST
    • Add or Update Call Title
      POST
    • Duplicate Scorecard
      POST
    • Archive Scorecard
      DELETE
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  • Subscriptions
    • List Webhook Subscriptions
    • Create Webhook Subscription
    • Delete Webhook Subscription
  1. Scorecards

List Scorecards

GET
https://platform-api.convirza.com/v3/scorecards
Scorecards
Last modified:2026-07-24 13:10:44
Returns a paginated list of scorecards accessible to the authenticated user.
Access Control
Requires scorecard component access (component_id = 927)
Requires score_call permission
Returns scorecards within user's organizational scope
System scorecards are included only if show_standard_cai_scorecard is enabled for the billing account
Excludes deleted scorecards
Filtering
scorecard_id — Filter by specific scorecard ID (must be > 0)
org_unit_id — Filter by org unit ID (must be > 0)
scorecard_name — Partial name search (case-insensitive)
Validation
org_unit_id and scorecard_id must be greater than 0
Returns 400 Bad Request if values are 0 or negative
Returns 404 Not Found if scorecard_id is specified but the scorecard does not exist
Returns 404 Not Found if org_unit_id is specified but no scorecards exist for that org unit
Returns 404 Not Found if scorecard_name is specified but no scorecards match the search
Pagination
limit — Records per page (max 200, default 100)
offset — Number of records to skip (default 0)
Sorting
sort_by — Field to sort by (scorecard_name, scorecard_id, date_created, status) - default: scorecard_id
sort_order — Sort direction (asc, desc) - default: desc
Example Request
GET /v3/scorecards/list?limit=50&offset=0&scorecard_name=quality

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Responses

🟢200
application/json
Scorecards retrieved successfully
Bodyapplication/json

🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://platform-api.convirza.com/v3/scorecards?offset=&limit=&sort_by=&sort_order=&org_unit_id=&scorecard_name=&scorecard_id=&status=' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "code": 200,
    "message": "Success",
    "data": {
        "scorecards": [
            {
                "scorecard_id": 3,
                "group_id": 70035,
                "scorecard_name": "test scorecard",
                "scorecard_instructions": "text://",
                "applied_to_groups": "70035,70292,70418,71928,71931,71932,71933,71935,71937,71938,71939,71940,71941,71960,71963,71974,71975,71977,71984,71985,71986,71991,71992,71993,71995,71996,71997,71998,72058,72065,72072,72153,72156,72158,72159,72161,72173,72187,72220,72221,72222,72223,72224,72225,72549,73445,73448,73449,73450,73458,73492,73555,73945,73948,73953,73963,73969,73970,73976,73977,73978,73979,73980,73981,73982,73983,73984,73985",
                "created_by": "Tom Cook",
                "date_created": "2023-01-04T13:01:14.000Z",
                "system_scorecard": false,
                "scorecard_status": "active",
                "scorecard_outcome_label": "Scorecard Outcome Label",
                "ai_outcome": false,
                "outcome_indicator_id": null,
                "has_sections": false,
                "total_score_outcome": false,
                "total_score_threshold": null
            }
        ],
        "scorecards_retrieved": 1,
        "total_scorecards": 42,
        "offset": 0,
        "limit": 100
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}
Modified at 2026-07-24 13:10:44
Previous
Delete Insight
Next
Get Scored Calls Report
Built with