GET
/
v1
/
groups
cURL
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
header
required

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Query Parameters

​
groupId
string
required

The ID of the group

Response

The group was successfully found

​
name
string

The name of the group

Example:

"Acme Inc."

​
groupId
string

The ID of the group as defined in your own application

Example:

"x34daa11-3745-4ac0-880e-d4b4d51fe13f"

​
createdAt
string<date-time>

The date the group was created

Example:

"2021-01-01T00:00:00.000Z"

​
modifiedAt
string<date-time>

The date the group was last modified

Example:

"2021-01-01T00:00:00.000Z"

​
properties
string

The properties of the group

Example:
{
  "name": "Acme Inc.",
  "companyUrl": "https://example.com",
  "logoUrl": "https://example.com/logo.jpg"
}
​
membersCount
number

The number of members in the group

Example:

42

​
trackingEvents
string[]

The tracking events associated with the group

Example:
[
  {
    "event": "SignedUp",
    "properties": {
      "source": "landing-page",
      "campaign": "summer-sale"
    },
    "createdAt": "2024-01-01T00:00:00Z"
  }
]