Listar membros
Listar os membros associados à comunidade
Required scopes:heycamp_read_members
GET
https://api.eduzz.com/heycamp/v1/members/community/: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
startDate
datetime
Data usada para definir o inicio do filtro com base na data de criação
endDate
datetime
Data usada para definir o final do filtro com base na data de criação
status
enum
Status do membro
active
deleted
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
Membros
items[n].id
number
Id do membro
items[n].email
string
Email do membro
items[n].name
string
Nome do membro
items[n].createdAt
datetime
Data de criação/aceite do convite
items[n].deletedAtNullable
datetime
Data de exclusão do membro
items[n].origin
string
Esta é a fonte de onde o usuário recebeu o convite
items[n].referrerUrl
url
Esta é a url do SSO associado ao usuario
items[n].socialMedias
object
Lista com links das mídias sociais do membro
items[n].socialMedias.instagram
url
Url do instagram do membro
items[n].socialMedias.facebook
url
Url do facebook do membro
items[n].socialMedias.linkedin
url
Url do linkedin do membro
items[n].socialMedias.x
url
Url do x(twitter) do membro
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 leitura |
Exemplos
1curl --request GET \
2 --url 'https://api.eduzz.com/heycamp/v1/members/community/cb655282-1903-402f-a02d-1f78cd388426' \
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": 2,
4 "itemsPerPage": 2,
5 "totalItems": 4,
6 "items": [
7 {
8 "id": 3843,
9 "email": "teste@test.com",
10 "name": "Teste",
11 "createdAt": "2024-10-21T17:10:54.000Z",
12 "deletedAt": null,
13 "origin": "invitations",
14 "referrerUrl": "https://www.domains.com/SSO/",
15 "socialMedias": {
16 "instagram": "https://www.instagram.com/[PERFIL DO MEMBRO]",
17 "facebook": "https://www.facebook.com/[PERFIL DO MEMBRO]",
18 "linkedin": "https://www.linkedin.com/in/[PERFIL DO MEMBRO]",
19 "x": "https://x.com/[PERFIL DO MEMBRO]"
20 }
21 },
22 {
23 "id": 3844,
24 "email": "teste2@test.com",
25 "name": "Teste 2",
26 "createdAt": "2024-10-21T17:10:54.000Z",
27 "deletedAt": null,
28 "origin": "invitations",
29 "referrerUrl": "https://www.domains.com/SSO/",
30 "socialMedias": {
31 "instagram": "https://www.instagram.com/[PERFIL DO MEMBRO]",
32 "facebook": "https://www.facebook.com/[PERFIL DO MEMBRO]",
33 "linkedin": "https://www.linkedin.com/in/[PERFIL DO MEMBRO]",
34 "x": "https://x.com/[PERFIL DO MEMBRO]"
35 }
36 }
37 ]
38}