- Teams are supported for AppSheet Enterprise accounts only.
- You must be team root or admin to manage and monitor your team using the API.
You can use the AppSheet API to to perform the following tasks:
If your team user accounts are managed by your Google Workspace organization, don't use the API to automate the removal of team users accounts. To control access to AppSheet by users in the organization, see Turn AppSheet on or off for users.
The following sections provide general guidance for using the AppSheet API to monitor and manage teams:
Required headers
To call the AppSheet team APIs, you need to pass the following headers:
|
Header |
Description |
|
|
API key. To generate an API key:
|
|
|
Your user account ID. |
Use curl
The examples throughout the documentation use curl to demonstrate how to use the AppSheet API. curl is an open source, command-line tool for transferring data with URL syntax, supporting common protocols such as HTTP and HTTPS.
The following table summarizes the curl command-line options used in the examples.
|
Option |
Description |
|
|
Defines a request header. See Required headers. |
|
|
Specifies the type of request (GET, POST, and so on). |
The following provides an example AppSheet API call using curl:
curl https://{appsheet-region}/api/v2/admin/reports/usage \
-X GET \
-H "AccessKey: DcTx1-TFq3c-7ka6t-PcnnI-7d0dO-M4wTm-vWwx0-1KBte" \
-H "UserId: 1234567"
Where:
| Variable | Description |
|
|
Domain used to invoke the API based on the supported data residency regions. Valid values include:
Note: The |