GET
/
v1
/
groups
curl --request GET \
  --url https://api.frigade.com/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "name": "Acme Inc.",
  "groupId": "x34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "modifiedAt": "2021-01-01T00:00:00.000Z",
  "properties": {
    "name": "Acme Inc.",
    "companyUrl": "https://example.com",
    "logoUrl": "https://example.com/logo.jpg"
  },
  "membersCount": 42,
  "trackingEvents": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      },
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Authentication header of the form Bearer: <token>, where <token> is your public or private Frigade API key

Query Parameters

groupId
string
required

The ID of the group

Response

200 - application/json
name
string

The name of the group

groupId
string

The ID of the group as defined in your own application

createdAt
string

The date the group was created

modifiedAt
string

The date the group was last modified

properties
string

The properties of the group

membersCount
number

The number of members in the group

trackingEvents
string[]

The tracking events associated with the group