API

List Forum Members

GET /v1/forums/{forumId}/spotMembers

List Forum Members

Path parameters

  • forumId string Required

    The id of the forum

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

  • email[in] array[string]

    The emails of spot member to include in the result

  • firstname[in] array[string]

    The firstnames of spot member to include in the result

  • lastname[in] array[string]

    The lastnames of spot member to include in the result

  • role[in] array[string]

    The roles of spot member to include in the result

    Values are Member or Admin.

  • registrationDate[before] integer

    Spot members where registration date is before a specific date (Unix timestamp format)

  • registrationDate[after] integer

    Spot members where registration date is after a specific date (Unix timestamp format)

Responses

  • 200 application/json

    Forum members returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items attributes object
      • id string Required

        The id of the spot member.

      • spotId string Required

        The id of the spot.

      • userId string | null Required

        The id of the user.

      • email string Required

        The email of the spot member.

      • title string | null Required

        The title of the spot member.

      • lang string Required

        The lang of the spot member.

        Values are en, fr, de, it, es, pt, or nl.

      • role string Required

        The role of the spot member.

        Values are Member or Admin.

      • customRoleId string | null Required

        The custom role ID of the spot member.

      • status string Required

        The status of the spot member.

        Values are Accepted, Deactivated, DeclinedInvitation, Invited, Left, Pending, or Rejected.

      • firstname string Required

        The firstname of the spot member.

      • lastname string Required

        The lastname of the spot member.

      • warnings number Required

        The number of warnings the spot member has.

      • embedBaseUrls object Required

        The custom embed base URLs of the spot member.

        Hide embedBaseUrls attributes Show embedBaseUrls attributes object
        • default string
        • * string Additional properties
      • updatedAt integer | null Required

        Timestamp in ms of updated date

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

GET /v1/forums/{forumId}/spotMembers 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/forums/{forumId}/spotMembers'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "spotId": "string",
      "userId": "string",
      "email": "string",
      "title": "string",
      "lang": "en",
      "role": "Member",
      "customRoleId": "string",
      "status": "Accepted",
      "firstname": "string",
      "lastname": "string",
      "warnings": 42.0,
      "embedBaseUrls": {
        "default": "string",
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "updatedAt": 42
    }
  ],
  "total": 42
}