GET/api/v1/asset-groups

Product availabilityAlgaPSA

List asset groups for a client

Returns the client’s bundles and shared workspaces with member and people counts. client_id is required.

RBAC · asset

Query parameters

client_idstring <uuid>Required

Required; groups belong to a client.

Response body

Success response 200 · schema AssetGroupListResponse

dataarray of AssetGroupRequired

itemsobject

group_idstring <uuid>Required

client_idstring <uuid>Required

namestringRequired

kindstringRequired

A bundle has one owner and moves as a unit; a shared workspace has users and its members carry no single assignee.

Enum: bundleshared_workspace

location_idstring <uuid>Nullable

location_namestringNullable

descriptionstringNullable

member_countinteger

people_countinteger

membersarray of object

itemsobject

asset_idstring <uuid>Required

asset_namestringNullable

asset_typestringNullable

asset_tagstringNullable

asset_statusstringNullable

contactsarray of object

itemsobject

contact_name_idstring <uuid>Required

contact_namestringNullable

rolestringRequired

Enum: owneruser

Response codes

200

Asset groups returned successfully.

400

client_id is missing or not a UUID.

401

x-api-key is missing at middleware.

403

Caller lacks asset read permission.

500

Unexpected error.

GET /api/v1/asset-groups

cURL

curl -X GET "https://algapsa.com/api/v1/asset-groups?client_id=01HN2K7VRB9PQ3Y0000000000" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/asset-groups?client_id=01HN2K7VRB9PQ3Y0000000000", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/asset-groups?client_id=01HN2K7VRB9PQ3Y0000000000");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "group_id": "01HN2K7VRB9PQ3Y0000000000",
      "client_id": "01HN2K7VRB9PQ3Y0000000000",
      "name": "string",
      "kind": "bundle",
      "location_id": "01HN2K7VRB9PQ3Y0000000000",
      "location_name": "string",
      "description": "string",
      "member_count": 1,
      "people_count": 1,
      "members": [
        {
          "asset_id": "01HN2K7VRB9PQ3Y0000000000",
          "asset_name": "string",
          "asset_type": "string",
          "asset_tag": "string",
          "asset_status": "string"
        }
      ],
      "contacts": [
        {
          "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
          "contact_name": "string",
          "role": "owner"
        }
      ]
    }
  ]
}