API Reference

Introduction

The Admin API is based on REST and has predictable resource-oriented URLs. The Admin API uses standard HTTP verbs and status codes and returns JSON-encoded responses.

The Admin API protects access to user data using OAuth 2.0. Login credentials are never shared with third party apps. Authorization is provided to third party applications via an Access Token.

The Access Token is encoded in JSON Web Token format.

The Authentication Framework - Tokens article has information on the various Tokens.

Base URL

See the Base URL topic.

Versioning

See the Versioning topic.

Authentication

See the Authentication topic.