Skip to main content
GET
/
v1
/
groups
/
{id}
Get a group
curl --request GET \
  --url https://api.scrip.dev/v1/groups/{id} \
  --header 'X-API-Key: <api-key>'
{
  "balances": {
    "7a2d4f8b-1c3e-4d5f-a6b7-8c9d0e1f2a3b": "1500.00"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Sales Team",
  "status": "ACTIVE",
  "updated_at": "2024-01-15T10:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

Use this file to discover all available pages before exploring further.

Returns a single group by its ID, including current balances per asset. The response contains id, name, status, timestamps, and a balances map. Members, tags, attributes, and counters are not included in this response. Use the dedicated members, tags, attributes, and counters endpoints to retrieve those. Archived groups are still retrievable by ID.
For usage patterns and examples, see the Groups guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
id
string<uuid>
required

Group ID

Response

Group details with balances

​
balances
object

Current total balances keyed by asset ID (decimal strings)

Example:
{
  "7a2d4f8b-1c3e-4d5f-a6b7-8c9d0e1f2a3b": "1500.00"
}
​
created_at
string<date-time>

When this group was created

Example:

"2024-01-15T10:30:00Z"

​
deleted_at
string<date-time>

When the group was archived (present only if archived)

​
id
string<uuid>

Unique identifier for this group

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string

Display name of the group

Example:

"Sales Team"

​
status
string

Lifecycle status: ACTIVE or ARCHIVED

Example:

"ACTIVE"

​
updated_at
string<date-time>

When this group was last updated

Example:

"2024-01-15T10:30:00Z"