Listar convites
Listar convites
Required scopes:heycamp_read_invitations
GET
https://api.eduzz.com/heycamp/v1/invitations/:communityId
Path params
communityId
ID da comunidade que você deseja pesquisar por membros associados
Query params
page
number
Página atual
itemsPerPage
number
Número de itens por página
Response params (200)
pages
number
Número de páginas
page
number
Página atual
itemsPerPage
number
Número máximo de itens por página
totalItems
number
Número total de items
items
array of object
items[n].id
number
Id do convite
items[n].email
string
Email do membro convidado
items[n].invitedBy
number
Id do responsável pelo convite
items[n].createdAt
datetime
Data de criação/envio do convite
items[n].redeemedAt
datetime
Data em que o convite foi aceito
Status codes
Status | Descrição |
200 | Success |
403 | O usuário não pode executar a ação porque não possui uma conta associada aos nossos serviços |
403 | O usuário não pode executar a ação porque o ID da comunidade fornecido não pertence ao mesmo |
403 | O usuário não pode executar a ação porque não forneceu um ID de aplicativo válido |
403 | O usuário não tem permissão de escrita |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/heycamp/v1/invitations/3040 \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'
Response
1{
2 "page": 1,
3 "pages": 10,
4 "itemsPerPage": 2,
5 "totalItems": 30,
6 "items": [
7 {
8 "id": 4239,
9 "email": "teste@test.com",
10 "invitedBy": 3949,
11 "createdAt": "2024-10-21T18:02:22.000Z",
12 "redeemedAt": "2024-10-21T18:03:51.000Z"
13 },
14 {
15 "id": 4240,
16 "email": "teste2@test.com",
17 "invitedBy": 3949,
18 "createdAt": "2024-10-21T22:29:32.000Z",
19 "redeemedAt": "2024-10-21T22:40:42.000Z"
20 }
21 ]
22}