v1

latestOpenAPI 3.1.02026-07-26183980.3 KB

external

external-v2

Search Collections

Search collections using free-text relevance matching. Returns a bounded relevance-ranked result set and does not return next_page. For deterministic chronological pagination, use GET /v2/collections.

post/v2/collections/search

Request body

filter_by_created_afterstring date-time nullable

Optional inclusive lower bound for collection creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_created_beforestring date-time nullable

Optional inclusive upper bound for collection creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_updated_afterstring date-time nullable

Optional inclusive lower bound for collection update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_updated_beforestring date-time nullable

Optional inclusive upper bound for collection update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

querystring nullable

Optional text query for relevance matching across collections. If omitted, search can still return a bounded general set.

Example request

{
  "filter_by_created_after": "2025-04-01T14:30:45Z",
  "filter_by_created_before": "2025-04-30T23:59:59Z",
  "filter_by_updated_after": "2025-04-01T14:30:45Z",
  "filter_by_updated_before": "2025-04-30T23:59:59Z"
}

Response

request_idstring required

Identifier for this API request. Useful for tracing and support.

totalinteger required

Number of collections returned by this bounded search response.

Example response

{
  "request_id": "api-request-018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
  "results": [
    {
      "created_at": "2025-03-18T11:00:00Z",
      "description": "Saved recipes from around the web",
      "id": "018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
      "note_count": 10,
      "title": "Recipe Notes",
      "updated_at": "2025-04-22T16:12:34Z"
    }
  ],
  "total": 1
}