Workspace Groups

1. List Workspace Groups

Returns a list of all workspace groups.

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

• Method: GET

• Description: Retrieves a paginated list of workspaces.

Query Params

Name	Type	Required	Description
page	integer	No	Page number (default: 1)
page_size	integer	No	Number of results per page (default: 10)
search	string	No	Key used as search filter
context_id	uuid	No	ID of the context to which the group belongs
sort_field	string	No	Field used to sort the results (default: created_at)
sort_order	string	No	Determines the sorting order of the results (default: ASC)

Notes on Parameters

• page_size: If the value provided is greater than 100, it will automatically be converted to this value (100).

• sort_field: name or created_at

• sort_order: ASC or DESC

Example Request

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

Successful Response (200 OK)

{
  "code": "success",
  "data": [
    {
      "id": "uuid",
      "name": "Group name",
      "description": "Description",
      "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": "Workspace name",
          "description": "Description",
          "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
  }
}

Error Response (400 Bad Request)

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

Error Response (401 Unauthorized)

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

Error Response (403 Forbidden)

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

---

2. Access Workspace Group Information

Returns information about a specific group.

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

• Method: GET

• Description: Returns information about a single group.

Query Params

Name	Type	Required	Description

Example Request

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

Successful Response (200 OK)

{
  "code": "success",
  "data": {
    "id": "uuid",
    "name": "Group name",
    "description": "Description",
    "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": "Workspace name",
        "description": "Description",
        "context_id": "uuid",
        "access_scope": "private",
        "created_at": "2025-01-01T00:00:00.911Z",
        "business_id": "uuid",
        "workspace_group_id": "uuid"
      }
    ],
    "access_scope": "public"
  }
}

Error Response (400 Bad Request)

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

Error Response (401 Unauthorized)

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

Error Response (403 Forbidden)

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

Error Response (404 Not Found)

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