Manage and monitor your team using the API

You can use the AppSheet API to to perform the following tasks:

• Monitor your team including team usage, membership, and billing information
• Automate the removal of team users accounts

The following sections provide guidance on using the AppSheet API to monitor and manage teams:

• Required headers
• Use curl

Required headers

To call the AppSheet team APIs, you need to pass the following headers:

Header	Description
AccessKey	API key. To generate an API key: Navigate to My Account > Settings. Under API Settings click Generate Api Key. Click Save.
UserId	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
-H --header	Defines a request header. See Required headers.
-X	Specifies the type of request (GET, POST, and so on).

The following provides an example AppSheet API call using curl:

curl https://www.appsheet.com/api/v2/admin/reports/usage \
  -X GET \
  -H "AccessKey: DcTx1-TFq3c-7ka6t-PcnnI-7d0dO-M4wTm-vWwx0-1KBte" \
  -H "UserId: 1234567"