Skip to content

Group Identify API

Feature availability

This feature is available in Growth and Enterprise accounts with the Accounts add-on.

Use the Group Identify API to set or update properties of particular groups.

The Amplitude Accounts add-on makes analytical functionality available at the group level. A group is an object that a set of users might belong to, like a company of customers, team of users, or a playlist with listeners. Groups can help you understand how accounts interact with your product, instead of how individual users interact.

Get more examples for this API

Run our Postman Collection for a full library of example requests and responses for this API.

Run in Postman

Authorization

This API doesn't use authorization, but uses your API key. Pass your API key in the body of the request like api-key={{api_key}}.

Endpoints

Region Endpoint
Standard Server https://api2.amplitude.com/groupidentify
EU Residency Server https://api.eu.amplitude.com/groupidentify

Considerations

  • Updates affect only future events, and don't update historical events.
  • You can track up to 5 unique group types and 10 total groups.

Example request

Set or update group properties.

https://api2.amplitude.com/groupidentify

POST /groupidentify?api_key={{api-key}}&identification={"group_properties":{"org csm":"Lucas","org plan":"Enterprise","org owner":"Luis"},"group_value":"1234","group_type":"org id"} HTTP/1.1
Host: api2.amplitude.com

Required parameters

Name
Description
api_key Your project API key.
identification Either a single JSON identification object or an array of JSON objects, each of which represents one identification.

Identification parameter keys

Key
Description Example
group_type String. Group type. "org name", "org id"
group_value String. One specific value of the group_type.
"group_type":"org id","group_value":"12345678" or "group_type":"account name","group_value":"Acme Corp"
group_properties String. A dictionary of key-value pairs that represent data tied to the group. Each distinct value appears as a group segment on the Amplitude dashboard.
You can store property values in an array, and date values are transformed into string values. See the next table for supported operations.
{"arr": "10000", "cs": \["Justin", "Ben"\], "renewal_date": “01/01/2018" }

group_properties supports these operations:

Operation
Description
$set Set the value of a property.
$setOnce Set the value of a property, prevent overriding the property value.
$add Add a numeric value to a numeric property.
$append and $prepend Append and prepend the value to a group property array.
$unset Remove a property.

Status codes

Code Message
200 Success
400 Bad request. See the error message for specifics.

Last update: 2022-03-09