Manage and monitor your team using the API

Notes:
  • Teams are supported for Enterprise accounts only.
  • You must be team root to manage and monitor your team using the API.

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

The following sections provide guidance on 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

AccessKey

API key.

To generate an API key:

  1. Navigate to My Account > Settings.
  2. Under API Settings click Generate Api Key.
  3. 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"

Was this helpful?
How can we improve it?

Need more help?

Try these next steps:

Search
Clear search
Close search
Google apps
Main menu
Search Help Center
false
false
false
false