👥 Groups v1: How to Use It

🔍 What is the Transactions API?

The Groups API v1 allows you to retrieve information about the user groups defined in your Clara account. Groups are typically used to organize users into departments, business units, or approval chains.

This API can be used to:

• Display group options when assigning users or policies
• Link transactions or cards to internal teams
• Build internal reporting dashboards by group

🆚 Note: This version of the API is read-only. To create, update, or delete groups, use Groups API v2.

📌 Available Endpoints

Operation	Endpoint	Method
Find all groups	/v1/groups	GET
Find group by UUID	/v1/groups/{uuid}	GET

1️⃣ Find all groups

Use this endpoint to retrieve the list of all groups configured in your organization. Each group includes metadata such as name, status, and unique ID.

🔗 Endpoint

GET /v1/groups

📤 cURL Request

cURL

curl -X GET \
"https://public-api.mx.clara.com/api/v1/groups" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📥 Sample JSON Response

JSON

[
  {
    "uuid": "group-001",
    "name": "Finance",
    "status": "ACTIVE"
  },
  {
    "uuid": "group-002",
    "name": "Sales",
    "status": "ACTIVE"
  }
]

2️⃣ Find group by UUID

Use this endpoint to fetch details for a specific group by its UUID.

🔗 Endpoint

GET /v1/groups/{uuid}

📤 cURL Request

cURL

curl -X GET \
"https://public-api.mx.clara.com/api/v1/groups/group-001" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📥 Sample JSON Response

JSON

{
  "uuid": "group-001",
  "name": "Finance",
  "status": "ACTIVE"
}

💡 Tip: Use the uuid of a group to associate users, approval flows, or reporting filters with that group.

⚠️ Note: The v1 API does not allow modifying groups — it is read-only and intended for lookup operations.