EDeduzz
HeyCamp

Listar os membros associados à comunidade

Changed on
get/heycamp/v1/members/community/:communityId

Request

Path parameters

communityIdstring required

Id da comunidade que você deseja pesquisar por membros associados

Example:3040

Query parameters

pagenumber

Página atual

itemsPerPagenumber

Número de itens por página

startDatestring date-time

Data usada para definir o inicio do filtro com base na data de criação

endDatestring date-time

Data usada para definir o final do filtro com base na data de criação

status'active' | 'deleted'

Status do membro

Response

Lista de membros associados

pagesnumber required

Número de páginas

pagenumber required

Página atual

itemsPerPagenumber required

Número máximo de itens por página

totalItemsnumber required

Número total de items

Example response

{
  "items": [
    {
      "email": "test@test.com",
      "name": "Usuario de teste",
      "createdAt": "2024-10-21T18:02:22.000Z",
      "deletedAt": "2024-10-21T18:02:22.000Z",
      "origin": "invitation",
      "referrerUrl": "https://www.domains.com/SSO/",
      "socialMedias": {
        "instagram": "https://www.instagram.com/[PERFIL DO MEMBRO]",
        "facebook": "https://www.facebook.com/[PERFIL DO MEMBRO]",
        "linkedin": "https://www.linkedin.com/in/[PERFIL DO MEMBRO]",
        "x": "https://x.com/[PERFIL DO MEMBRO]"
      }
    }
  ]
}

Changes

  • f93320e6a417Revision changes
    • info

      the query request parameter endDate became optional

    • info

      the query request parameter itemsPerPage became optional

    • info

      the query request parameter page became optional

    • info

      the query request parameter startDate became optional

    • info

      the query request parameter status became optional

  • 8e41c62b53a8Revision changes
    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      the query request parameter endDate became required

    • breaking

      the query request parameter itemsPerPage became required

    • breaking

      the query request parameter page became required

    • breaking

      the query request parameter startDate became required

    • breaking

      the query request parameter status became required

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter endDate

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter startDate

    • breaking

      for the query request parameter endDate, the format changed from no format to date-time

    • breaking

      for the query request parameter itemsPerPage, the type changed from string to number

    • breaking

      for the query request parameter page, the type changed from string to number

    • breaking

      for the query request parameter startDate, the format changed from no format to date-time

    • info

      added the new enum value active to the query request parameter status

    • info

      added the new enum value deleted to the query request parameter status