Resources

Lists API

Search and page through CredibleMind's curated resource lists.

Returns curated resource lists available to your client, sorted by rating. Filter by topic or by words in the list title.

GET https://api.crediblemind.com/{client}/resources/lists

Parameters

NameInTypeRequiredDefaultNotes
x-api-keyheaderstringYesYour API key. See Authentication.
clientpathstringYesYour client identifier.
pgSizequeryintegerNo20Lists per page.
pagequeryintegerNo1Page number, starting at 1.
topicsquerystringNoTopic slugs, comma-separated (topics=anxiety,sleep) or repeated (topics=anxiety&topics=sleep). Returns lists tagged with any of them. Get slugs from the Topics API.
qquerystringNoWords to match in the list title.

Do not send lang

This endpoint is English only. Sending any lang value, including en, currently returns lists with empty titles and descriptions.

Request

curl "https://api.crediblemind.com/acme/resources/lists?topics=anxiety,sleep&pgSize=10&page=1" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "numResults": 34,
  "pgSize": 10,
  "page": 1,
  "results": [
    {
      "title": "Best Apps for Better Sleep",
      "description": "Our top-rated apps to help you fall asleep and stay asleep.",
      "imageUrl": "https://images.ctfassets.net/example/best-sleep-apps.jpg",
      "slug": "best-apps-for-better-sleep",
      "path": "/lists/best-apps-for-better-sleep",
      "averageRating": 4.5
    }
  ]
}
FieldTypeDescription
numResultsnumberTotal number of matching lists across all pages.
pgSizenumberLists per page, as requested.
pagenumberPage returned, as requested.
results[].titlestringList title.
results[].descriptionstringShort description. May be an empty string.
results[].imageUrlstringList image. May be an empty string.
results[].slugstringList slug. Use it with the Resource Details API to get the resources in the list.
results[].pathstringPath of the list, starting with /. See Paths in responses.
results[].averageRatingnumberAverage rating. Missing when the list has no rating.

Errors

StatusBodyWhen
401{ "error": "Invalid API Client or Key" }The key is missing or does not match client.
500{ "message": "..." }Unexpected server error.

If the search itself fails, the response is 200 with an empty object {}. Treat a response without results as an error.

On this page