Frameworks

Search frameworks by name, stage and date

Search and filter framework agreements and dynamic purchasing systems. Every parameter is optional. Use a framework's id as the framework_id filter on notice search to find the call-offs made under it.

get/v1/frameworks/search

Request

  • Base URL: https://api.stotles.com
  • URL: https://api.stotles.com/v1/frameworks/search
  • Auth: API key in header x-api-key

Query parameters

querystring

Free-text search over the framework name (2–500 characters).

stagestring[]

Filter to frameworks in these procurement stages. Repeatable.

start_date_gtestring date

Only frameworks whose contract start date is on or after this date (inclusive).

start_date_ltestring date

Only frameworks whose contract start date is on or before this date (inclusive).

end_date_gtestring date

Only frameworks whose contract end date is on or after this date (inclusive).

end_date_ltestring date

Only frameworks whose contract end date is on or before this date (inclusive).

sort'title' | 'start_date' | 'end_date' | 'stage' | 'value'

Sort field. Omitted = relevance ranking.

order'asc' | 'desc'

Sort direction (default desc). Applies when sort is set.

limitinteger

Maximum results per page (1–50, default 20). Ignored when cursor is set.

cursorstring

Opaque pagination cursor from a previous response's next_cursor. Carries the page and page size, so limit is ignored when it is present.

Response

A page of matching framework agreements.

next_cursorstring nullable required

Opaque cursor for the next page of results; null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.