List custom activity groups

Returns the caller's saved custom activity groups (created and ordered in the web app), each with its ordered item references. Read-only: clients bucket the unified activity list into these groups for a "My groups" view. Pass `targetUserId` to read another user's groups (requires `user_schedule:update` / `user_schedule:read_all`). Membership and ordering are changed via the `/groups/items` endpoints.

Query parameters

targetUserIdstringOptional

Another internal user whose groups to read (requires elevated schedule permission). Omit for self.

Response body

Success response 200 · schema CustomActivityGroupsResponseV1

dataarray of objectRequired

itemsobject

groupIdstringRequired

groupNamestringRequired

sortOrdernumberRequired

isCollapsedbooleanRequired

itemsarray of objectRequired

itemsobject

itemIdstringRequired

activityIdstringRequired

activityTypestringRequired

sortOrdernumberRequired

metaany

Response codes

200

The caller's custom activity groups.

401

Authentication required.

403

Permission denied (reading another user's groups).

500

Unexpected failure resolving groups.

GET /api/v1/activities/groups

cURL

curl -X GET "https://algapsa.com/api/v1/activities/groups?targetUserId=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/activities/groups?targetUserId=string", {
  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/activities/groups?targetUserId=string");
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": [
    {
      "groupId": "string",
      "groupName": "string",
      "sortOrder": 0,
      "isCollapsed": false,
      "items": [
        {
          "itemId": "string",
          "activityId": "string",
          "activityType": "string",
          "sortOrder": 0
        }
      ]
    }
  ],
  "meta": null
}