Get started with the RudderStack Group API call.
group call lets you link an identified user with a group like a company, organization, or an account. You can also record any custom traits associated with that group like the company name, number of employees, etc.
An identified user can be a part of more than one group.
A sample payload for the
group event after removing the Common fields is as shown:
group call has the following fields in addition to the Common fields:
|String||Required||Your group’s unique identifier which lets you identify the group in your database.|
|Object||Optional||Includes the traits of the group such as |
employees, etc. For more more information, check the Traits) section below.
Traits are bits of information included in an
group call that add more context to the group. Some example of traits include the number of employees in the group, name of the industry the group is a part of, or the website of the group.
RudderStack has some reserved traits that it handles in special ways. These are listed in the table below:
|String||The group's unique ID.|
|String||The group name.|
|String||The group's email address.|
|String||Phone number associated with the group|
The group's street address. This can optionally contain either/all of the following fields:
The name of the industry that the group is a part of.
Date of the group's account creation. We recommend using the ISO-8601 date string format.
|String||The group's description.|
Number of the employees in the group. This is typically used for companies.
|String||The plan that the group is subscribed to.|
|String||The group's website.|
|String||URL of the group's avatar image.|
Questions? Contact us by email or on