How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Google Cloud Firestore Documents API

Operations on Firestore documents

Google Cloud Firestore Documents API is one of 2 APIs that Google Cloud Firestore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 6 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://firestore.googleapis.com/v1.

6 operations 3 paths 5 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://firestore.googleapis.com/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Google Cloud Firestore Documents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 6

Operations on Firestore documents

GET
/projects/{project}/databases/{database}/documents/{collectionId}
Google Cloud Firestore List documents
listDocuments 6 params → 200
POST
/projects/{project}/databases/{database}/documents/{collectionId}
Google Cloud Firestore Create a document
createDocument 4 params body → 200
GET
/projects/{project}/databases/{database}/documents/{collectionId}/{documentId}
Google Cloud Firestore Get a document
getDocument 4 params → 200404
PATCH
/projects/{project}/databases/{database}/documents/{collectionId}/{documentId}
Google Cloud Firestore Update a document
updateDocument 5 params body → 200
DELETE
/projects/{project}/databases/{database}/documents/{collectionId}/{documentId}
Google Cloud Firestore Delete a document
deleteDocument 4 params → 200
POST
/projects/{project}/databases/{database}/documents:runQuery
Google Cloud Firestore Run a query
runQuery 2 params body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Value (11 properties), Document (4 properties), RunQueryResponse (3 properties), ListDocumentsResponse (2 properties). Each schema is shown below with its type and property counts.

Value
object
11 properties
RunQueryResponse
object
3 properties
Document
object
4 properties
RunQueryRequest
object
1 property
ListDocumentsResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-cloud-firestore-documents-api-openapi.yml Raw ↑

Other APIs Google Cloud Firestore publishes across the network.

Google Cloud Firestore Databases API
Where this information came from

This is an independent, third-party profile of Google Cloud Firestore Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.