FlipFlip Utility API
Groups

List groups

Returns all groups for a program. Groups let you organize enrollments for targeted event dispatch.

GET
/v1/programs/{programId}/groups
AuthorizationBearer <token>

API key passed as a Bearer token. Contact your Flip account manager to obtain credentials.

In: header

Path Parameters

programIdstring

Response Body

curl -X GET "https://api-utility.flip.energy/v1/programs/string/groups"
[
  {
    "id": "my-group",
    "name": "My Group"
  }
]
{
  "code": "string",
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ],
  "errors": [
    {
      "message": "string",
      "path": "string"
    }
  ],
  "message": "string",
  "status_code": 0
}
{
  "code": "string",
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ],
  "errors": [
    {
      "message": "string",
      "path": "string"
    }
  ],
  "message": "string",
  "status_code": 0
}
{
  "code": "string",
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ],
  "errors": [
    {
      "message": "string",
      "path": "string"
    }
  ],
  "message": "string",
  "status_code": 0
}