FRfrigadehq
groups

GET /v1/groups

Find a group by ID

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

groupIdstring required

The ID of the group

Response

The group was successfully found

namestring

The name of the group

groupIdstring

The ID of the group as defined in your own application

createdAtstring date-time

The date the group was created

modifiedAtstring date-time

The date the group was last modified

propertiesstring

The properties of the group

membersCountnumber

The number of members in the group

trackingEventsstring[]

The tracking events associated with the group

Example response

{
  "name": "Acme Inc.",
  "groupId": "x34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "modifiedAt": "2021-01-01T00:00:00.000Z",
  "membersCount": 42,
  "trackingEvents": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      },
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

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