Groups

Get a group

Retrieve a group by ID.

get/v1/groups/{group_id}

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/groups/{group_id}
Auth: HTTP bearer

Path parameters

group_idstring uuid required

The group's id.

Response

Group details

attributesobject

Key-value metadata. An empty object when the group has none.

counter_settingsobject

Auto-reset settings for the counters that have one, keyed by counter key. An empty object when no counter resets. Set them with reset_after on a counter in PATCH.

countersobject

Numeric accumulators, returned as strings for precision. An empty object when the group has none.

created_atstring date-time

When this group was created

deleted_atstring date-time

When the group was archived (present only if archived)

idstring uuid

Unique identifier for this group

namestring

The name people see for the group.

status'ACTIVE' | 'ARCHIVED'

The group's lifecycle state.

tagsstring[]

Labels for segmentation. An empty list when the group has none.

updated_atstring date-time

When this group was last updated

Example response

{
  "attributes": {
    "plan": "premium",
    "region": "us-east"
  },
  "counters": {
    "points_earned": "1500",
    "purchases": "42"
  },
  "created_at": "2027-01-15T10:30:00Z",
  "deleted_at": "2027-01-15T10:30:00Z",
  "id": "0b9e7d3c-5a41-4f68-a2c7-81e4d6b3f907",
  "name": "Sales Team",
  "status": "ACTIVE",
  "tags": [
    "enterprise"
  ],
  "updated_at": "2027-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.