Grupos de Espacios de Trabajo

1. Listar grupos de espacios de trabajo

Devuelve una lista de todos los grupos de espacios de trabajo.

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

  • 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 grupo

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-groups?context_id=uuid \
     -H "Authorization: Bearer "

Respuesta Exitosa (200 OK)

{
  "code": "success",
  "data": [
    {
      "id": "uuid",
      "name": "Nombre del grupo",
      "description": "Descripción",
      "created_by_id": "uuid",
      "updated_by_id": "uuid",
      "created_at": "2025-01-01T00:00:00.911Z",
      "updated_at": "2025-01-01T00:00:00.911Z",
      "business_id": "uuid",
      "context_id": "uuid",
      "workspaces": [
        {
          "id": 1234,
          "name": "Nombre del espacio de trabajo",
          "description": "Descripción",
          "context_id": "uuid",
          "access_scope": "private",
          "created_at": "2025-01-01T00:00:00.911Z",
          "business_id": "uuid",
          "workspace_group_id": "uuid"
        }
      ],
      "access_scope": "public"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 10,
    "total": 1
  }
}

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 grupo de espacios de trabajo

Devuelve la información de un grupo específico.

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

  • Método: GET

  • Descripción: Devuelve información de un solo grupo.

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-groups/{id} \
     -H "Authorization: Bearer "

Respuesta Exitosa (200 OK)

{
  "code": "success",
  "data": {
    "id": "uuid",
    "name": "Nombre del grupo",
    "description": "Descripción",
    "created_at": "2025-01-01T00:00:00.911Z",
    "updated_at": "2025-01-01T00:00:00.911Z",
    "business_id": "uuid",
    "context_id": "uuid",
    "workspaces": [
      {
        "id": 1234,
        "name": "Nombre del espacio de trabajo",
        "description": "Descripción",
        "context_id": "uuid",
        "access_scope": "private",
        "created_at": "2025-01-01T00:00:00.911Z",
        "business_id": "uuid",
        "workspace_group_id": "uuid"
      }
    ],
    "access_scope": "public"
  }
}

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-group/not-found",
  "message": "Grupo de espacio de trabajo no encontrado"
}
PreviousEspacios de TrabajoNextVisualizaciones

Last updated