This document is intended for developers who are using the TeamworkIQ API. If you are looking for information about managing account members, please see Manage Team Members instead.

Account roles

A user who is currently associated with an account will have one of the

following account roles:

  • member

  • invitee

If the user is a member, then the user MAY have additional roles:

  • admin

  • template_creator

  • owner

You may also notice

  • users who have the account role named robot

  • users who have no account roles.

Robot users

"Robot" not real human users. When you create an application in the TeamworkIQ Integration Center, a "robot" user is automatically created. When your application performs actions using the TeamworkIQ API, these actions are attributed to the robot user. Thus, if your application client launches a process, then the started_by property of that process will specify the user number of a robot rather than that of a human user.

The account_roles property of a robot user will contain the robot role. It does not contain any other roles.

A robot user has a name (the name of the client application). It does not have an email address.

A human user can NEVER be assigned the `robot` role, and a robot user can NEVER be assigned any other account role or process role.

Users who have been removed from the account

Former members or invitees who have been removed from the account can be retrieved using the Account API. These users have NO account roles.

The TeamworkIQ API provides information about former users because their user numbers may appear in activity streams, processes or templates. For example, if user 12345 started a process and was subsequently removed from the account, your client application may nevertheless need to determine the identity of the user who started the process.

To list the account's users

To obtain a list of all current and former members and invitees, use the following API:

GET /v3/accounts/{acc}/users  

Did this answer your question?