Find One

Gets record by specified database unique id or filter.

Finds one database record. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place.

[FindOne] - Gets record by specified database unique id.

get

Finds one database record. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place. https://docs.codemash.io/api/database/collections/find-one

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

IdstringRequired

Id of a record. Required if filter is not set.

CollectionNamestringRequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Query parameters

ExcludeSchemabooleanOptional

Use the IncludeSchema property when you want to have schema definition in the API response as well. This is useful when you have dynamic data rendering and want to have context over your data structure and how it should be displayed. By default schema is excluded.

ExcludeCulturebooleanOptional

Set ExcludeCulture property to "true" when you want to return all the data translations from translatable fields. This is useful when you want to take care about translations in the front-end side. E.g.: when you want to enter product description in your project supported languages.

IncludeUserNamesbooleanOptional

If your collection record has relationship with the Users collection from the Membership module, you can set IncludeUserNames property to "true" to get full user name and id information altogether without making any extra roundtrip to the server.

IncludeRoleNamesbooleanOptional

If your collection record has relationship with the system Roles from the Membership module, you can set IncludeRoleNames property to "true" to get full role name and id information altogether without making any extra roundtrip to the server.

IncludeCollectionNamesbooleanOptional

If your collection record has relationship with other collections from the Database module, you can set IncludeCollectionNames property to "true" to get display name and id information altogether without making any extra roundtrip to the server.

IncludeTermNamesbooleanOptional

If your collection record has relationship with the taxonomy terms from the Database module, you can set IncludeTermNames property to "true" to get term name and id information altogether without making any extra roundtrip to the server.

AddReferencesFirstbooleanOptional

If true, then references are injected before your list queries are applied

Header parameters

Acceptstring · enumRequired

Accept Header

Possible values:

X-CM-ClusterstringOptional

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdstringRequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

Responses

200

Success

application/json

get

/{version}/db/{CollectionName}/{Id}

HTTPcURLJavaScriptPython

GET /{version}/db/{CollectionName}/{Id} HTTP/1.1
Host: api.codemash.io/
Authorization: YOUR_API_KEY
Accept: application/json
X-CM-ProjectId: text

200

Success

{
  "schema": {
    "collection_name_as_title": "text",
    "collection_name": "text",
    "ui_schema": "text",
    "json_schema": "text",
    "translatable_fields": [
      "text"
    ],
    "database_id": "text",
    "schema_id": "text"
  },
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "result": "text"
}

[FindOne] - Gets record by specified database unique id.

post

Finds one database record. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place. https://docs.codemash.io/api/database/collections/find-one

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

IdstringRequired

Id of a record. Required if filter is not set.

CollectionNamestringRequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Query parameters

IncludeTermNamesbooleanOptional

If your collection record has relationship with the taxonomy terms from the Database module, you can set IncludeTermNames property to "true" to get term name and id information altogether without making any extra roundtrip to the server.

AddReferencesFirstbooleanOptional

If true, then references are injected before your list queries are applied

Header parameters

Acceptstring · enumRequired

Accept Header

Possible values:

X-CM-ClusterstringOptional

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdstringRequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

Body

application/x-www-form-urlencoded

ProjectionstringOptional

Use projection (in JSON format) to return only fields that are required to work with. This is useful to reduce the amount of the returned fields, have less complexity on the frontend and lower network traffic.

ExcludeSchemabooleanOptional

Use the IncludeSchema property when you want to have schema definition in the API response as well. This is useful when you have dynamic data rendering and want to have context over your data structure and how it should be displayed. By default schema is excluded.

ExcludeCulturebooleanOptional

Set ExcludeCulture property to "true" when you want to return all the data translations from translatable fields. This is useful when you want to take care about translations in the front-end side. E.g.: when you want to enter product description in your project supported languages.

IncludeUserNamesbooleanOptional

If your collection record has relationship with the Users collection from the Membership module, you can set IncludeUserNames property to "true" to get full user name and id information altogether without making any extra roundtrip to the server.

IncludeRoleNamesbooleanOptional

If your collection record has relationship with the system Roles from the Membership module, you can set IncludeRoleNames property to "true" to get full role name and id information altogether without making any extra roundtrip to the server.

IncludeCollectionNamesbooleanOptional

If your collection record has relationship with other collections from the Database module, you can set IncludeCollectionNames property to "true" to get display name and id information altogether without making any extra roundtrip to the server.

Responses

200

Success

application/json

post

/{version}/db/{CollectionName}/{Id}

HTTPcURLJavaScriptPython

POST /{version}/db/{CollectionName}/{Id} HTTP/1.1
Host: api.codemash.io/
Authorization: YOUR_API_KEY
Accept: application/json
X-CM-ProjectId: text
Content-Type: application/x-www-form-urlencoded
Content-Length: 142

"Projection='text'&ExcludeSchema=true&ExcludeCulture=true&IncludeUserNames=true&IncludeRoleNames=true&IncludeCollectionNames=true"

200

Success

{
  "schema": {
    "collection_name_as_title": "text",
    "collection_name": "text",
    "ui_schema": "text",
    "json_schema": "text",
    "translatable_fields": [
      "text"
    ],
    "database_id": "text",
    "schema_id": "text"
  },
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "result": "text"
}

.NET

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var person = await service.FindOneByIdAsync(
    "{RECORD_ID}",
    new DatabaseFindOneOptions()
);

Check the docs about entities on how the response record is deserialized into your class object.

Node

PHP

Check the docs on how to form projections. Check the docs on how to use references.

Find One (by using a filter)

GET https://api.codemash.io/:version/db/:collectionName/findOne

Gets a record by using a filter. This endpoint accepts GET and POST methods.

Path Parameters

Name	Type	Description
version	string	A version of the API endpoint.
collectionName	string	The name of the collection to get a record from.

Query Parameters

Name	Type	Description
filter	string	Filter document. This allows you to find a record by a custom filter. More about filters follow the link below.
referencedFields	array	Fields to left join. More about referencing fields follow the link below.
addReferencesFirst	boolean	If set to true, left joins first before applying other processing to main records. More about referencing fields follow the link below.
cultureCode	string	Language code. If your record has translatable fields, those fields will only include this specified language. If not provided, will take language from the Accept-Language header.
projection	string	Projection document. This allows you to specify what fields to return decreasing the amount of data transferred. More about projections follow the link below.
includeSchema	boolean	If set to true, includes your collection details in the response.
excludeCulture	boolean	Culture code or Accept-Language header will be used for translatable fields. If you want to get values in all languages, set this as true.

Headers

Name	Type	Description
Authorization	string	Secret API key which belongs to your project or user. Not required if using cookies with a session ID.
x-cm-projectid	string	Your project's ID. Can be passed as a query parameter.

200 Returns a single record matched by a filter. Here singular quotes are used to avoid escaping double quotes.

{
    "result": "{ '_id': '5e37136bf59f3a3f940b99a4', 'name': 'John' }",
    "schema": null,
}

.NET

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var person = await service.FindOneAsync(
    x => x.Id == "{RECORD_ID}",
    new DatabaseFindOneOptions()
);

Check the docs about entities on how the response record is deserialized into your class object.

Node

PHP

Check the docs on how to form projections, filters. Check the docs on how to use references.