Appearance

List Scorecard templates ​

Endpoint ​

http
GET /unified/conversational-intelligence/scorecard-templates
Integrations supported
  • Gong

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

result
object[]

List of Scorecard templates

id
string
REQUIRED · 

The unique identifier for the scorecard template

Supported in
  • Gong
name
string

Name of the scorecard template

Supported in
  • Gong
type
string

The type of the scorecard template in the source system

Supported in
  • Gong
enabled
boolean

Whether the scorecard template is enabled in the source system

Supported in
  • Gong
review_method
string

Default review method for the template. Can be manual, automatic, or both.

fields
object[]

The scorecard fields

Supported in
  • Gong
id
string

The field's unique identifier

name
string

The field's name. This is the name of the property in the entity.

label
string

The field's label

placeholder
string

The field's placeholder

description
string

The field's description

position
number

The index position of field in the scorecard template.

type
string

The field's type. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • statement
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • rating
  • slider
  • ranking
  • group
  • matrix
format
string

The format of the field.

All possible enum values:
  • url
  • email
  • password
validation
string

The validation string for the field.

range
object

The range applicable for field types number, rating, scale.

min
number

The minimum range for the field.

min_label
number

The label for the minimum range of the field.

max
number

The maximum range for the field.

max_label
number

The label for the maximum range of the field.

is_required
boolean

Whether the field is required

is_overall
boolean

Whether this field is the overall summary question

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

field_group
object

The field's group identifier. If present, the field is part of a group.

id
string

The field groups's identifier

name
string

The field groups's name

label
string

The field groups's label

rows
object[]

The field's rows. If present, the field's type is matrix

label
string

The row's label

value
string

The row's value

description
string

The row's description

columns
object[]

The field's columns. If present, the field's type is matrix

label
string

The column's label

value
string

The column's value

description
string

The column's description

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

workspace
object

The workspace to which the scorecard template belongs.

Supported in
  • Gong
id
string

The unique identifier of the workspace.

name
string

The name of the workspace.

created_by
object

User who last updated the scorecard template in the source system.

Supported in
  • Gong
id
string

The unique identifier for a user

name
string

The name of the user

created_at
string · date-time

Creation time of the scorecard template

Supported in
  • Gong
updated_at
string · date-time

Last updated time of the scorecard template

Supported in
  • Gong
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

debug
object

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. null for static responses or when truto_skip_api_call=true.

requestUrl
string
requestOptions
object
data
responseHeaders
object
nextCursor
string
isLooping
boolean
isEmptyResult
boolean
resultCount
number