List opportunities

GET

/api/v1/opportunities

curl --request GET \
  --url 'https://app.prokure.ca/api/v1/opportunities?sort=score&limit=25'

Parameters

Query Parameters

status

Array<string>

Allowed values: scored screened notified draft_requested draft_sent approved archived

q

string

>= 1 characters <= 200 characters

source

string

>= 1 characters <= 40 characters

deadline_before

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

deadline_after

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

min_score

number

<= 100

sort

string

default: score

Allowed values: score deadline discovered_at

cursor

string

<= 300 characters

limit

integer

default: 25 >= 1 <= 100

Responses

200

Default Response

Media typeapplication/json

object

items

required

Array<object>

object

source_status

required

string

Allowed values: active cancelled complete unsuccessful withdrawn planned planning unknown

id

required

string

rfp_id

required

string

title

required

string

issuing_body

required

string

source

required

string

deadline

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

estimated_value

required

Any of:

number

number

null

null

score

required

Any of:

number

number

null

null

score_source

required

Any of:

string

string

null

null

status

required

string

archived_at

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

product_match_name

required

Any of:

string

string

null

null

discovered_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

explanation

required

Any of:

string

string

null

null

summary

required

Any of:

string

string

null

null

source_url

required

Any of:

string

string

null

null

notice_type

required

Any of:

string

string

null

null

solicitation_number

required

Any of:

string

string

null

null

latest_feedback_action

required

Any of:

string

string

null

null

latest_feedback_at

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

nextCursor

required

Any of:

string

string

null

null

Example

{
  "items": [
    {
      "source_status": "active"
    }
  ]
}

400

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"
}

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

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

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

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"
}