Groups

The authenticated user needs to be an administrator to perform these actions.

For the full XML representation of groups, check out the data reference.

Get group

• GET /groups/#{id}.xml returns a single group and the users associated with it.

Response:

<group>
  <id type="integer">1</id>
  <name>Partners</name>
  <users>
    <user>
      ...
    </user>
    <user>
      ...
    </user>
  </users>
</group>

Get groups

• GET /groups.xml returns a collection of groups.

Response:

<groups>
  <group>
    ...
  </group>
  <group>
    ...
  </group>
</groups>

Create group

• POST /groups.xml creates a new empty group. Users are added to the group through memberships.

Request:

<group>
  <name>Partners</name>
</group>

Response:

Status: 201 Created
Location: https://example.highrisehq.com/groups/#{new-group-id}.xml

<group>
  ...
</group>

Update group

• PUT /groups/#{id}.xml updates an existing group with a new name.

Request:

<group>
  <name>Senior Partners</name>
</group>

Response:

Status: 200 OK

Destroy group

• DELETE /groups/#{id}.xml destroys the group at the referenced URL.

Response:

Status: 200 OK