Workspaces

1. Listar Workspaces

Retorna uma lista de todos os workspaces.

• URL: /lighthouse/orgs/{org_id}/businesses/{business_id}/workspaces

• Método: GET

• Descrição: Recupera uma lista paginada de workspaces.

Query Params

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página (padrão: 1)
page_size	integer	Não	Número de resultados por página (padrão: 10, max: 100)
search	string	Não	Chave utilizada como filtro de busca
context_id	uuid	Não	Id do contexto ao qual o workspace está inserido
workspace_group_id	uuid	Não	Id do grupo onde o workspace está inserido
sort_field	string	Não	Campo utilizado na ordenação dos resultados (padrão: created_at)
sort_order	string	Não	Determina a ordenação dos resultados (padrão: ASC)

Observações sobre os parâmetros

• page_size: se o valor forncido for maior que 100, será convertido automaticamente para este valor (100).

• sort_field: name ou created_at

• sort_order: ASC ou DESC

Exemplo de Requisição

curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/workspaces \
     -H "Authorization: Bearer <access_token>"

Resposta de Sucesso (200 OK)

{
  "code": "success",
  "data": {
    "workspaces": [
      {
        "id": 1,
        "name": "Nome do workspace",
        "description": null,
        "access_scope": "public",
        "created_at": "2022-01-01T00:01:45.941Z",
        "workspace_group_id": "uuid",
        "count_views": 1
      }
    ]
  },
  "meta": {
    "total": 1,
    "page": 1,
    "pageSize": 10,
    "sortBy": {
      "field": "created_at",
      "order": "ASC"
    }
  }
}

Resposta de Erro (400 Bad Request)

{
  "code": "bad-request/invalid-parameters",
  "message": "error message"
}

Resposta de Erro (401 Unauthorized)

{
  "code": "failed",
  "message": "invalid or expired token"
}

Resposta de Erro (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "Unable to give access to the user"
}

---

2. Acessar informações de workspace

Retorna as informações de um workspace especifico.

• URL: /lighthouse/orgs/{org_id}/businesses/{business_id}/workspaces/{id}

• Método: GET

• Descrição: Retorna informações de um único workspace.

Query Params

Nome	Tipo	Obrigatório	Descrição

Exemplo de Requisição

curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/workspaces/1234 \
     -H "Authorization: Bearer <access_token>"

Resposta de Sucesso (200 OK)

{
  "code": "success",
  "data": {
    "id": 1234,
    "name": "Nome do workspace",
    "description": "Descrição do workspace",
    "access_scope": "public",
    "workspace_group_id": "uuid",
    "views": [
      {
        "id": 123,
        "name": "Nome da visualização",
        "description": "Descrição",
        "created_at": "2025-01-01T00:00:00.911Z",
        "workspace_id": 1234
      }
    ]
  }
}

Resposta de Erro (400 Bad Request)

{
  "code": "bad-request/invalid-parameters",
  "message": "error message"
}

Resposta de Erro (401 Unauthorized)

{
  "code": "failed",
  "message": "invalid or expired token"
}

Resposta de Erro (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "Unable to give access to the user"
}

Resposta de Erro (404 Not Found)

{
  "code": "workspace/not-found",
  "message": "Workspace not found"
}