Page Comparison

...

• Please raise a support request via https://www.teamform.co/help

• Request an API secret, include the tenant and workspace (you will need to be a TeamForm administrator, or have obtained their permission to obtain api access)

  • Upon successful completion of your request, you will receive from TeamForm a client_id, and a client_secret.

  • Both pieces of information should be treated like a password - keep them secret, and only store them securely.

...

• Data is real time (vs access via TeamForm reporting which has a ~1hr lag)

• Can be integrated into Enterprise applications or reporting suites such as PowerBI and Tableau

• Excessive calls can impact performance of a customer TeamForm instance. By default, the api is rate limited to 20 requests per second, so individual calls should be less than this.

What does a typical API call flow look like, once I have my key and ID?

• to begin, use the secret key and Client ID to make a request for a TeamForm API access token.

  • this access token will automatically expire after 24 hours, see above for an example.

• you can now start making requests! On each request, you must include your access token, gained above. For example, to make a cURL request to the getTeams endpoint:

  • Code Block
    curl --request GET \ --url https://api.teamform.co/<tenant id>/<tenant id>/api/getTeams --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <access token>' --data '<your request payload>'

    Note:

    • you’ll also need to add in your <tenant id> to this example, in the --url section.

    • the region ID must be added to the --url when making calls outside of the Asia Pacific (see https://teamform.atlassian.net/wiki/spaces/TFWOS/pages/2852290854/What+is+the+2924085317/TeamForm+Public+API#Making-your-first-query )

I want to get all people and all teams, what is the best way to do this?

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

• to bulk fetch people, use the /searchTeams endpoint

• To link people to teams, use (e.g.) 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)

• to bulk fetch team hierarchy, use getTeams, using same approach above

• to bulk fetch tags, use getPeopleTags and get TeamTags