Espaços

Notas
Nível expert
A chave da API deve ser enviada como token Bearer no cabeçalho Authorization Obter sua chave da API.
Lista

Endpoint da API:

GET 
https://www.xurl.ooo/api/v1/spaces

Exemplo de requisição: 

curl --location --request GET 'https://www.xurl.ooo/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
Consulta de pesquisa
search_by
opcional string
Pesquisar por. Valores possíveis: name para Nome Padrão: name
sort_by
opcional string
Ordenar por. Valores possíveis: id para Data de criação, name para Nome Padrão: id
sort
opcional string
Ordenar. Valores possíveis: desc para Decrescente, asc para Crescente Padrão: desc
per_page
opcional integer
Resultados por página. Valores possíveis: 10, 25, 50, 100 Padrão: 100
Mostrar

Endpoint da API:

GET 
https://www.xurl.ooo/api/v1/spaces/{id}

Exemplo de requisição: 

curl --location --request GET 'https://www.xurl.ooo/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Armazenar

Endpoint da API:

POST 
https://www.xurl.ooo/api/v1/spaces

Exemplo de requisição: 

curl --location --request POST 'https://www.xurl.ooo/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parâmetro
Tipo
Descrição
name
obrigatório string
Nome do espaço
color
opcional integer
Código de cor Valores possíveis: 1, 2, 3, 4, 5, 6 Padrão: 1
Atualizar

Endpoint da API:

PUT PATCH 
https://www.xurl.ooo/api/v1/spaces/{id}

Exemplo de requisição: 

curl --location --request PUT 'https://www.xurl.ooo/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
name
opcional string
Nome do espaço
color
opcional integer
Código de cor Valores possíveis: 1, 2, 3, 4, 5, 6
Excluir

Endpoint da API:

DELETE 
https://www.xurl.ooo/api/v1/spaces/{id}

Exemplo de requisição: 

curl --location --request DELETE 'https://www.xurl.ooo/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'