This document is intended for developers who are using the TeamworkIQ API. More general concept information about groups may be found in TemplateIQ Groups.

Each group is identified by a number that is unique within TeamworkIQ. In fact, it is guaranteed that that user and group numbers never clash with each other, so that if a group's number is N, no user will have N as its user number and no other group will have N as its group number.

Every group also has a human-readable name and a status.


Each group has a status property that specifies the status of the group. Supported statuses are:

  • ACTIVE groups are currently active and can be used.

  • DEACTIVATED groups were active, but have been deactivated and can no longer be used.

References to groups may remain in activity streams or template role assignments after the groups have been deactivated.

Did this answer your question?