List groups

You need information about the prevailing group to access most PAPI interfaces. This operation provides a read-only list of groups, which may contain properties. This operation provides a flat list of groups, along with parentGroupId information to structure them as a hierarchy. Each group also lists any available contracts that enable property features, but not which group contains a given property. Use the Identity and Access Management API to assign properties to groups, and modify the group hierarchy.

Recipes
List groups
Open Recipe
Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers
string
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Responses

Response body
object
string

Identifies the prevailing account under which you requested the data. See ID prefixes for details on how to omit the ID's act_ prefix.

string

A descriptive name for the account.

groups
object

The set of requested groups, available within an items array.

items
array of objects

Encapsulates information about the group that contains a property. Relevant response objects appear within the outer envelope's groups.items array.

items
object
contractIds
array of strings
required
length ≥ 1

A set of string identifiers for contracts whose products can be applied to properties within a group.

contractIds*
string
required

Identifies each group. See ID prefixes for details on how to omit the ID's grp_ prefix.

string
required

A descriptive label for the group.

string

Identifies another group as a parent, defining the relative location of the group within the group hierarchy. If omitted, it's the root-level group at the top of the hierarchy.

Headers
object
integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remaining number of requests allowed each minute per account. See Rate and resource limiting for details.

Language
URL