Sign in
resources

Returns a collection of resources

Changed on

Returns a collection of resources. Filters by resource type, topic name and category slug are optional. Resources that match all filters are fetched.

get/api/v1/resources

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

categorySlugstring
Example:react

Slug of the category for which to retrieve resources

topicSlugstring
Example:jsx

Slug of the topic for which to retrieve resources

resourceTypesstring[]

Resource types to filter by

topicstring
Example:cln2u09xo0037s6wvbf6t9jfg

ID string of the topic for which to retrieve resources. If not provided, resources for ALL topics are fetched.

statusstring[]

Status to filter by

searchstring

Search query to filter by

Response

Successful operation

idstring required
titlestring required
slugstring required
descriptionstring nullable
urlstring uri required
resourceType'BLOG' | 'VIDEO' | 'TUTORIAL' required
categoryIdstring required
isFavoriteboolean required

Example response

[
  {
    "title": "My Resource in Javascript",
    "slug": "my-resource-in-javascript",
    "description": "Lorem ipsum javascript",
    "url": "https://tutorials.cat/learn/javascript",
    "categoryId": "clocr0bi20000h8vwipfbazso",
    "topics": [
      {
        "topic": {
          "name": "React Props",
          "slug": "react-props"
        }
      }
    ],
    "voteCount": {
      "upvote": 14,
      "downvote": 2,
      "total": 12
    }
  }
]

Changes

  • 385767b4260cRevision changes
    • info

      api operation id listResources was added

  • 36d5913c4275Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the required property // to the response with the status