API Index

Overview of the API methods offered by 3Box

3Box APIs allow developers to interact with 3Box data stores in various ways. This page contains an overview of the methods offered by the 3Box SDK.

Static vs. Stateful API Methods

  • Static API methods are always available to developers and do not require user authentication. They are limited to reading public information from stores. Static methods are performed on the Box object.

  • Stateful API methods are only available to developers while the user is active on their app and require user authentication, achieved with the Auth API. Stateful methods can be performed on the box, space, and thread object.

Identity

Static

Stateful

Auth

Static

Stateful

Profiles

GET

Static

Stateful

SET

Stateful

REMOVE

Stateful

Storage (Spaces)

GET

Static

Stateful

SET

Stateful

REMOVE

Stateful

Messaging (Threads)

VIEW

Static

CREATE

Stateful

READ

Stateful

ADD/REMOVE

Stateful

CAPABILITIES

Stateful