Skip to content
Prokure Docs

List learned decision rules

GET
/api/v1/settings/rules
curl --request GET \
  --url https://app.prokure.ca/api/v1/settings/rules

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
rules
required
Array<object>
object
id
required
string
rule_type
required
string
Allowed values: green_light no_go preference
description
required
string
signal
required
Any of:
string
source
required
Any of:
string
evidence_count
required
integer
>= -9007199254740991 <= 9007199254740991
last_evidence_at
required
Any of:
string
created_at
required
string
active
required
boolean
origin_rfp
required
Any of:
object
id
required
string
title
required
string
active_count
required
integer
>= -9007199254740991 <= 9007199254740991
cap
required
number
Allowed values: 40
Example
{
  "rules": [
    {
      "rule_type": "green_light"
    }
  ],
  "cap": 40
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}