Page Comparison

...

• 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 searchTeams endpoint, that will list all the teams in your active workspace:

  • Code Block
    language bash
    export API_TOKEN="<access token>" export TENANT_ID="<your tenant id>id, from the authorizer step above>" curl --request POST \ --url https://api.teamform.co/${TENANT_ID}/api/searchTeams \ --header 'Content-Type: application/json' \ --header "Authorization: Bearer ${API_TOKEN}" \ --data '{ "search": "", "size": 10 }'

    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

...