The group object

⚠️

Preview — this feature is being built; the design below is the spec.

The group object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "grp_01JCM0N2Q4S6U8W0Y2A4",
  "type": "group",
  "name": "data-science",
  "description": "Analysts and ML engineers",
  "source": "manual",
  "workspace_roles": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "role": "workspace_developer"
    }
  ],
  "member_count": 12,
  "created_at": "2026-09-01T10:00:00Z",
  "updated_at": "2026-11-01T10:00:00Z"
}

Fields

Field	Type	Description
`id`	string	Starts with `grp_`.
`type`	string	The object type, always `group`.
`name`	string	Name shown in the Console and in reports.
`description`	string	Free-text description.
`source`	string	`manual`, or `scim` for groups pushed by your identity provider. SCIM groups are read-only here except for `workspace_roles`.
`workspace_roles`	array	Roles every member receives in each workspace. A member’s effective role is the highest of their own and their groups’ roles.
`member_count`	integer	Current members.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).
`updated_at`	string	When it last changed.

Returned by

file inference_hook

Was this page helpful?