Listar espaços

Listar espaços

Required scopes:heycamp_read_spaces
GET
https://api.eduzz.com/heycamp/v1/spaces/community/:communityId

Path params

communityId

Id da comunidade que você deseja pesquisar os espaços associados

Query params

page
number

Página atual

itemsPerPage
number

Número de itens por página

Response params (200)

page
number

Página atual

pages
number

Número de páginas

itemsPerPage
number

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

totalItems
number

Número total de items

items
array of object

Espaços associados a comunidade

items[n].id
number

Id do espaço

items[n].name
string

Nome do espaço associado a comunidade

items[n].private
boolean

Informa se o espaço é público ou privado

Status codes

StatusDescrição
200Success
403O usuário não pode executar a ação porque não possui uma conta associada aos nossos serviços
403O usuário não pode executar a ação porque o id da comunidade fornecido não pertence ao mesmo
403O usuário não pode executar a ação porque não forneceu um id de aplicativo válido
403O usuário não tem permissão de leitura
Swagger Logo

Exemplos

1curl --request GET \
2	--url 'https://api.eduzz.com/heycamp/v1/spaces/community/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": 2,
4  "itemsPerPage": 1,
5  "totalItems": 2,
6  "items": [
7    {
8      "id": 1234,
9      "name": "Espaço",
10      "private": false
11    },
12    {
13      "id": 1020,
14      "name": "Espaço NOVO",
15      "private": true
16    }
17  ]
18}