EDeduzz
HeyCamp

Listar convites

Changed on
get/heycamp/v1/invitations/: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

status'accepted' | 'pending'

Filtrar por status do convite

Response

Lista de convites enviados

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",
      "createdAt": "2024-10-21T18:02:22.000Z",
      "redeemedAt": "2024-10-21T18:03:51.000Z",
      "invitationUrl": "https://[domain]/invitations/[member-token]"
    }
  ]
}

Changes

  • f93320e6a417Revision changes
    • info

      the query request parameter itemsPerPage became optional

    • info

      the query request parameter page 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 itemsPerPage became required

    • breaking

      the query request parameter page became required

    • breaking

      the query request parameter status became required

    • 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

    • info

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

    • info

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