Docs
API 1.39
Status
Proposals

List proposals

GET /v1/proposals: List proposals

GET /v1/proposals
Operation idlistProposals
Key scoperead: every key
SectionProposals

#Parameters

NameInTypeRequiredDescription
limitqueryinteger≥ 1 · ≤ 100 · default 25
cursorquerystringmin length 1
statusquery"pending", "approved", "rejected", "expired"
programquerystringmin length 1
kindquery"relocate", "dismiss", "insert_steps", "parser_config", "api_discovery"

#Example request

curl -X GET "https://api.kaab.ist/v1/proposals" \
  -H "Authorization: Bearer $KAAB_API_KEY"

#Responses

#200

Proposal page

FieldTypeRequiredDescription
dataProposalyes
next_cursorstring or nullyes

#Errors

Every error answers with the error envelope; its code is one of the error codes.

StatusWhen
400request_invalid: request validation failed
401Missing or invalid API key
403The key's scope does not cover this operation
429Rate limited; see Retry-After
500internal: unexpected server error

Was this page helpful?