---
title: PromisesApi
framework: CKTool JS
role: symbol
role_heading: Class
platforms: [cktool js 1.2.15+]
path: cktooljs/promisesapi
---

# PromisesApi

A class that exposes promise-based functions for interacting with the API.

## Declaration

```data
interface PromisesApi
```

## Mentioned in

Integrating CloudKit access into your JavaScript automation scripts

## Overview

Overview You use an instance of PromisesApi to interact with the API. Methods on this class return promises that complete with a response object.

## Topics

### Record Management

- [acceptRecord](cktooljs/promisesapi/acceptrecord.md)
- [createRecord](cktooljs/promisesapi/createrecord.md)
- [deleteRecord](cktooljs/promisesapi/deleterecord.md)
- [deleteRecordsByQuery](cktooljs/promisesapi/deleterecordsbyquery.md)
- [getRecord](cktooljs/promisesapi/getrecord.md)
- [lookupRecords](cktooljs/promisesapi/lookuprecords.md)
- [queryRecordChanges](cktooljs/promisesapi/queryrecordchanges.md)
- [queryRecords](cktooljs/promisesapi/queryrecords.md)
- [resolveRecord](cktooljs/promisesapi/resolverecord.md)
- [updateRecord](cktooljs/promisesapi/updaterecord.md)

### Zone Management

- [createZone](cktooljs/promisesapi/createzone.md)
- [deleteZone](cktooljs/promisesapi/deletezone.md)
- [getZone](cktooljs/promisesapi/getzone.md)
- [getZones](cktooljs/promisesapi/getzones.md)

### Database Management

- [exportSchema](cktooljs/promisesapi/exportschema.md)
- [getContainers](cktooljs/promisesapi/getcontainers.md)
- [importSchema](cktooljs/promisesapi/importschema.md)
- [resetConfigToProduction](cktooljs/promisesapi/resetconfigtoproduction.md)
- [resetToProduction](cktooljs/promisesapi/resettoproduction.md)
- [validateSchema](cktooljs/promisesapi/validateschema.md)

### Database Field Values, Structures and Enumerations

- [Field Values](cktooljs/field-values.md)
- [Database Structures and Enumerations](cktooljs/database-structures-and-enumerations.md)

### Asset Creation

- [createAssetUploadUrl](cktooljs/promisesapi/createassetuploadurl.md)

### User and Team

- [getSessionUser](cktooljs/promisesapi/getsessionuser.md)
- [getTeams](cktooljs/promisesapi/getteams.md)
- [Team](cktooljs/team.md)
- [TeamsResponse](cktooljs/teamsresponse.md)

### Initialization

- [PromisesApi](cktooljs/promisesapi/promisesapi.md)
- [PromisesApiOptions](cktooljs/promisesapioptions.md)
- [Security](cktooljs/security.md)

## See Also

### Promises API

- [CancellablePromise](cktooljs/cancellablepromise.md)
- [CKToolDatabaseModule](cktooljs/cktooldatabasemodule.md)