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/listsParameters
| Name | In | Type | Required | Default | Notes |
|---|---|---|---|---|---|
x-api-key | header | string | Yes | Your API key. See Authentication. | |
client | path | string | Yes | Your client identifier. | |
pgSize | query | integer | No | 20 | Lists per page. |
page | query | integer | No | 1 | Page number, starting at 1. |
topics | query | string | No | Topic 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. | |
q | query | string | No | Words 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
}
]
}| Field | Type | Description |
|---|---|---|
numResults | number | Total number of matching lists across all pages. |
pgSize | number | Lists per page, as requested. |
page | number | Page returned, as requested. |
results[].title | string | List title. |
results[].description | string | Short description. May be an empty string. |
results[].imageUrl | string | List image. May be an empty string. |
results[].slug | string | List slug. Use it with the Resource Details API to get the resources in the list. |
results[].path | string | Path of the list, starting with /. See Paths in responses. |
results[].averageRating | number | Average rating. Missing when the list has no rating. |
Errors
| Status | Body | When |
|---|---|---|
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.