get all

curl --request GET \
  --url http://localhost:8000/v1/genres/all

{
  "data": {
    "genres": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e14f586ced1463b2b60bc",
          "createdAt": "2024-10-15T07:08:37.804Z",
          "name": "Fiction",
          "updatedAt": "2024-10-15T07:08:37.804Z"
        },
        {
          "__v": 0,
          "_id": "670e3731648069ca43164de8",
          "createdAt": "2024-10-15T09:34:41.536Z",
          "name": "SciFi",
          "updatedAt": "2024-10-15T09:34:41.536Z"
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 2,
      "totalPages": 1
    }
  },
  "error": null
}

Genre

get all

Get All Genres

This endpoint makes an HTTP GET request to retrieve a list of all genres.

Request

Query Parameters

page (integer, optional): The page number for paginated results.
limit (integer, optional): The maximum number of genres to be returned per page.

Response

Upon a successful request, the API returns a JSON object with the following properties:

data (object): An object containing the genres data.
- genres (object): An object containing the array of genres and pagination details.
  - docs (array): An array of genre objects, each containing the following properties:
    - _id (string): The unique identifier for the genre.
    - name (string): The name of the genre.
    - createdAt (string): The timestamp of when the genre was created.
    - updatedAt (string): The timestamp of when the genre was last updated.
    - __v (integer): Version key for the genre.
  - totalDocs (integer): The total number of genres.
  - offset (integer): The offset of the current page.
  - limit (integer): The maximum number of genres per page.
  - totalPages (integer): The total number of pages.
  - page (integer): The current page number.
  - pagingCounter (integer): The paging counter.
  - hasPrevPage (boolean): Indicates if there is a previous page.
  - hasNextPage (boolean): Indicates if there is a next page.
  - prevPage (null or integer): The previous page number, if applicable.
  - nextPage (null or integer): The next page number, if applicable.
error (null): Indicates the absence of any error.

GET

genres

all

get all

curl --request GET \
  --url http://localhost:8000/v1/genres/all

{
  "data": {
    "genres": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e14f586ced1463b2b60bc",
          "createdAt": "2024-10-15T07:08:37.804Z",
          "name": "Fiction",
          "updatedAt": "2024-10-15T07:08:37.804Z"
        },
        {
          "__v": 0,
          "_id": "670e3731648069ca43164de8",
          "createdAt": "2024-10-15T09:34:41.536Z",
          "name": "SciFi",
          "updatedAt": "2024-10-15T09:34:41.536Z"
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 2,
      "totalPages": 1
    }
  },
  "error": null
}

Query Parameters

page

string

Example:

"1"

limit

string

Example:

"10"

Response

get all - success

data

object

Show child attributes

error

unknown

add filter