Available search parameters

Last updated: 3 months ago

The /resources endpoint accepts several parameters to refine your search results.

Basic search

POST https://api.cathopic.com/resources
{
  "query": "Saint Francis",
  "page": 1,
  "page_size": 20,
  "order": "popular"
}

Parameters

query (string, optional)

Your search term. Leave empty to get all resources.

  • Examples: "Virgin Mary", "Eucharist", "cross"

  • Supports fuzzy matching and typo tolerance

  • Searches across titles, descriptions, and tags

page (integer, default: 1)

Which page of results to return. Starts at 1.

page_size (integer, default: 20, max: 100)

Number of results per page. Maximum is 100 to maintain performance.

order (string, default: "popular")

How to sort results:

  • popular - Most downloaded resources first

  • recent - Newest uploads first

Response structure

{
  "total": 1523,
  "page": 1,
  "page_size": 20,
  "results": [
    {
      "id": 1234,
      "name": "Resource title",
      "description": "Resource description",
      "type": "photo",
      "orientation": "portrait",
      "thumbnail_url": "https://...",
      "author": { ... },
      "tags": ["tag1", "tag2"]
    }
  ]
}

Practical examples

Get the first 10 most popular resources about prayer:

{
  "query": "prayer",
  "page": 1,
  "page_size": 10,
  "order": "popular"
}

Get recent uploads, no specific search term:

{
  "query": "",
  "page": 1,
  "page_size": 50,
  "order": "recent"
}

Browse page 3 of saint images:

{
  "query": "saints",
  "page": 3,
  "page_size": 20,
  "order": "popular"
}

For full API reference, visit api.cathopic.com/docs.

Was this article helpful?