close anchor

Groups

To get information on groups:

GET /groups

Parameters

Param Type Description Optional
id string The UUID of an individual group.
type string The group type, or type of entity to be identified with the group, being one of the types provided by the /group/types endpoint..
group string Indicate, by providing a comma-delimited list, the UUID of user group(s) by which to filter groups. Include a '+' prefix before this list of groups if a group is to be identified with every group declared (the default behavior of this endpoint is to provide groups linked to any of the group(s) included), and prefix an individual group therein with '!' to exclude groups linked to it.
entities boolean Indicate whether to provide the entities in the group.
text string Include text by which to filter entries. Input will be parsed for up to ten keywords and treated as a filter, in that only entries with keyword(s) present in the fields below will be included.
fields string Indicate, by providing a comma-delimited list, the field(s) in which to expect text keyword(s) be present. If a field includes localized text, only values in the endpoint transaction locale will be queried. If empty or not provided, each of these valid fields will be included: description, name.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, id, name.

If plural locales indicated for the endpoint transaction and name is present in the list of field(s) to order by, querying will be performed in the initial locale (but data will be included for each).
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the group object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of group object(s).

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_type The group type is not valid.

If an error is not described on this page, the platform-wide error table provides further information.

To post a group:

POST /groups

In order to post a group, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
name string The name of the group, provided in the endpoint transaction locale.
description string The group description, provided in the endpoint transaction locale.
type string The group type, or type of entity to be identified with the group, being one of the types provided by the /group/types endpoint.

The data object provided by this endpoint is the group inserted to the project.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_name The group name is an empty value or not provided.
invalid_group_type The group type is not valid.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update a group:

PUT /groups

In order to edit or update a group, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The UUID of the group for which data is being updated.
name string The name of the group, provided in the endpoint transaction locale.
description string The group description, provided in the endpoint transaction locale.
groups array The user group(s) to which this group is to be linked, being a one-dimensional array in which each value is the UUID of an individual group.

The group will no longer be identified with or linked to groups not included in this transaction. In order to post a group link individually (not deleting it from other groups to which it'd previously been linked), use the /group/groups endpoint instead.
entities array The entities to be identified with this group, being a one-dimensional indexed array in which each value is the UUID of an individual entity of the type for which the group is provided, in order by the desired position of each. In order to post entities to a group, log in a user with owner-level privileges, or an editor in a user group linked to the group in question.

If there is no ordinal preference for entities in the group, the order in which one provides the entities in this transaction will be ignored. The group will no longer be identified with entities not included in this transaction. In order to post an entity to a group individually (not deleting or initializing the position of the other entities therein), use the /{entity}/groups endpoint provided for the type of entity in question instead.
attributes object The entity-attribute-value data to be identified with this entity.

The data object provided by this endpoint is the updated group object.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_name The group name provided is an empty value.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a group:

DELETE /groups

In order to delete a group, log in a user identified with owner-level privileges.

Parameters

Param Type Description
id string The UUID of the group to be deleted.

The data object provided by this endpoint is the deleted group.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*