Espacios de Trabajo

1. Listar espacios de trabajo

Devuelve una lista de todos los espacios de trabajo.

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

• Método: GET

• Descripción: Recupera una lista paginada de espacios de trabajo.

Query Params

Nombre	Tipo	Obligatorio	Descripción
page	integer	No	Número de página (por defecto: 1)
page_size	integer	No	Número de resultados por página (por defecto: 10, máx: 100)
search	string	No	Clave utilizada como filtro de búsqueda
context_id	uuid	No	ID del contexto al que pertenece el espacio de trabajo
workspace_group_id	uuid	No	ID del grupo al que pertenece el espacio de trabajo
sort_field	string	No	Campo utilizado para ordenar los resultados (por defecto: created_at)
sort_order	string	No	Determina el orden de los resultados (por defecto: ASC)

Notas sobre los parámetros

• page_size: Si el valor proporcionado es mayor que 100, se convertirá automáticamente a este valor (100).

• sort_field: name o created_at

• sort_order: ASC o DESC

Ejemplo de Solicitud

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

Respuesta Exitosa (200 OK)

{
  "code": "success",
  "data": {
    "workspaces": [
      {
        "id": 1,
        "name": "Nombre del espacio de trabajo",
        "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"
    }
  }
}

Respuesta de Error (400 Bad Request)

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

Respuesta de Error (401 Unauthorized)

{
  "code": "failed",
  "message": "token inválido o expirado"
}

Respuesta de Error (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "No se puede dar acceso al usuario"
}

---

2. Acceder a la información del espacio de trabajo

Devuelve la información de un espacio de trabajo específico.

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

• Método: GET

• Descripción: Devuelve información de un solo espacio de trabajo.

Query Params

Nombre	Tipo	Obligatorio	Descripción

Ejemplo de Solicitud

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

Respuesta Exitosa (200 OK)

{
  "code": "success",
  "data": {
    "id": 1234,
    "name": "Nombre del espacio de trabajo",
    "description": "Descripción del espacio de trabajo",
    "access_scope": "public",
    "workspace_group_id": "uuid",
    "views": [
      {
        "id": 123,
        "name": "Nombre de la vista",
        "description": "Descripción",
        "created_at": "2025-01-01T00:00:00.911Z",
        "workspace_id": 1234
      }
    ]
  }
}

Respuesta de Error (400 Bad Request)

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

Respuesta de Error (401 Unauthorized)

{
  "code": "failed",
  "message": "token inválido o expirado"
}

Respuesta de Error (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "No se puede dar acceso al usuario"
}

Respuesta de Error (404 Not Found)

{
  "code": "workspace/not-found",
  "message": "Espacio de trabajo no encontrado"
}