Project group object

A collection of related projects under a Client, which is used for organizing and filtering.

Example

{
  "id": "3fe0688e-e17d-4591-ba01-9a7dc61266f2",
  "name": "North America Group",
  "description": 'This is a group of projects located in North America.',
  "isActive": true,
  "createdAt": "2025-04-15T20:43:43.016Z",
  "client": {
    "id": "a2dab73b-ad63-4a9a-bae3-146feb85f8b4",
    "name": "Acme Company"
    },
  "projects": [
    {
      "id": "6f2beb51-ab85-41e5-8db8-a1c2c0ee1717",
      "name": "Acme Time & Materials Project"
    },
    {
      "id": "baede136-02e2-463d-ac56-b96a6f9c2d8f",
      "name": "Acme Retained Services"
    },
    {
      "id": "ee3f877c-44fb-41a8-b044-1f21a377071f",
      "name": "Vendor Portal"
    }
  ]		
}

Attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project group.
descriptionstringA description of the project group.
isActivebooleanFlag indicating whether the project group is active.
createdAttimestampThe timestamp when the object was created.
clientobjectA simple object to the related client. See attributes.
projectobjectA simple object to the related project. See attributes.

Client attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the client.

Project attributes

NameTypeDescription
iduuidThe unique identifier for the object.
namestringThe name of the project.