v1

latestOpenAPI 3.0.12026-07-2466310316.3 KB

Scorecards

List Scorecards

get/api/v1/scorecards

Query parameters

includestring[]

Scorecard relationships available for inclusion

Include related resources

fields[scorecards]ScorecardsReadableAttribute[]

Scorecard readable attributes list

Include only specified fields of Scorecard in response

fields[scorecard_notes]ScorecardNotesReadableAttribute[]

Scorecard Note readable attributes list

Include only specified fields of Scorecard Note in response

fields[scorecard_sections]ScorecardSectionsReadableAttribute[]

Scorecard Section readable attributes list

Include only specified fields of Scorecard Section in response

fields[user_scorecards]UserScorecardsReadableAttribute[]

User Scorecard readable attributes list

Include only specified fields of User Scorecard in response

fields[stages]StagesReadableAttribute[]

Stage readable attributes list

Include only specified fields of Stage in response

filter[scorecardable_type]string[]

Scorecardable type filter

Filter records by Scorecardable type

filter[updated_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at greater than this value

filter[updated_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at less than this value

filter[created_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at greater than this value

filter[created_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at less than this value

sortstring[]

Scorecard sortable attributes

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

page[number]integer

Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'

Example:count

Include the total number of matched records within the meta key of the response object.

Response

OK: Scorecards collection