MOmongodb

Find One Document

Find a single document that matches a query.

post/action/findOne

Request

  • Base URL
    https://data.mongodb-api.com/app/your-app-id/endpoint/data/v1
  • URL
    https://data.mongodb-api.com/app/your-app-id/endpoint/data/v1/action/findOne
  • Auth
    • API key in header Authorization
    • or API key in header email and API key in header password
    • or API key in header apiKey
    • or API key in header jwtTokenString

Request body

dataSourcestring required

The name of a linked MongoDB Atlas data source. This is commonly "mongodb-atlas" though it may be different in your App if you chose a different name when you created the data source.

databasestring required

The name of a database in the specified data source.

collectionstring required

The name of a collection in the specified database.

filterobject required

A MongoDB query filter that matches documents. For a list of all query operators that the Data API supports, see Query Operators.

projectionobject

A MongoDB projection for matched documents returned by the operation.

Response

Found

documentobject nullable

A document that matches the specified filter. If no documents match, this is null.

Changes

No recorded changes to this operation across all 3 revisions of this API.