Retrieve Group List

GET

/group

Retrieve the Group List

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.vplan.com/v1/group?with=resources' \
--header 'x-api-key: <api-key>' \
--header 'x-api-env: <api-key>'

Responses

🟢200Ok

application/json

Body

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "e6e8b017-1b67-4463-9505-97670d2ba735",
            "name": "Test Group",
            "created_at": "2025-07-30T14:08:54Z",
            "updated_at": "2025-07-30T14:08:54Z",
            "resources": []
        }
    ]
}

🟠401Not Logged In

Modified at 2025-10-30 09:44:22

Group

Create New Group