get users by interest

Get Interests by Genre

This endpoint retrieves a list of interests for a specific genre, with pagination support.

Request

• Method: GET
• URL: /interests/genre/:genreId
• Query Parameters:
  • page (number): The page number for paginated results (default: 1)
  • limit (number): The maximum number of interests per page (default: 10)

Response

The response will contain an array of interest documents under the “docs” key, along with pagination details. Each interest document includes information about the user who added the interest.

Example Response 1:

{
  "data": {
    "interests": {
      "docs": [],
      "totalDocs": 0,
      "offset": 0,
      "limit": 0,
      "totalPages": 0,
      "page": 0,
      "pagingCounter": 0,
      "hasPrevPage": true,
      "hasNextPage": true,
      "prevPage": null,
      "nextPage": null
    },
    "error": null
  }
}

Example Response 2:

{
  "data": {
    "interests": {
      "docs": [
        {
          "_id": "",
          "user": {
            "_id": "",
            "firstName": "",
            "lastName": "",
            "userName": "",
            "email": "",
            "role": "",
            "createdAt": "",
            "updatedAt": "",
            "__v": 0
          }
        }
      ],
      "totalDocs": 0,
      "offset": 0,
      "limit": 0,
      "totalPages": 0,
      "page": 0,
      "pagingCounter": 0,
      "hasPrevPage": true,
      "hasNextPage": true,
      "prevPage": null,
      "nextPage": null
    },
    "error": null
  }
}

GET /interests/genre/{genreId}

get users by interest

cURL

curl --request GET \
  --url http://localhost:8000/v1/interests/genre/{genreId}

200

get users by interest - success1

{
  "data": {
    "interests": {
      "docs": [],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 0,
      "totalPages": 1
    }
  },
  "error": null
}

Path Parameters

genreId · string · required

Example:

"670e14f586ced1463b2b60bc"

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

Response

200

application/json

get users by interest - success1 / get users by interest - success2

data · object

Show child attributes

error · unknown