Content Comparison

...

For customers using a branded URL please access /api-docs to your customer URL or access via the ? Support icon within the app:

...

the

...

How can I get an API secret / access?

...

• This information is visible by doing the following steps

• On the left hand menu (towards the bottom) click on the Question mark icon ？

• From there you will be presented with API doc guidance (bottom section) and the associated tenant and workspace IDs respectively. These are needed for you to create your API queries.

  Image Removed

Image Added

How do I get a bearer token and how does it work (e.g. expiry etc.)

...

• to bulk fetch team members, use the /searchPeople endpoint

• to bulk fetch peopleteams, use the /searchTeams endpoint. This also provides teams that have no team members, eg are structural.

• To link people to teams, use

  • getTeamsMemberships (provide list of Teams, gets people for each team) or

  • getPeopleMemberships (provide list of people, get teams of which they are members).

  • Recommended done in batches of <1000 people or teams to reduce api gateway load (Requires automation of api calls to cycle through a full list of people or teams, noting gateway limit of 20 requests per second for all calls. if this is exceeded a 504 GATEWAY TIMEOUT error will be issued. reduce the batch size and try again)

• to bulk fetch tags, use

  • getPeopleTags to get the tags applied to people

  • getTeamTags to get the tags applied to teams

  • noting that depending on the tag configuration in teamform, the same type of tag could be applied to both people and teams