Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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 GETPOST \
        --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

...