---
title: Point Field
label: Point
order: 110
desc: The Point field type stores coordinates in the database. Learn how to use Point field for geolocation and geometry.

keywords: point, geolocation, geospatial, geojson, 2dsphere, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
---

<Banner>
  The Point field type saves a pair of coordinates in the database and assigns an index for location
  related queries.
</Banner>

<Banner type="warning">
  <strong>Note:</strong> The Point field type is currently only supported in MongoDB.
</Banner>

<LightDarkImage
  srcLight="https://payloadcms.com/images/docs/fields/point.png"
  srcDark="https://payloadcms.com/images/docs/fields/point-dark.png"
  alt="Shows a Point field in the Payload admin panel"
  caption="Admin panel screenshot of a Point field"
/>

The data structure in the database matches the GeoJSON structure to represent point. The Payload APIs simplifies the object data to only the [longitude, latitude] location.

### Config

| Option             | Description                                                                                                                                                                               |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                    |
| **`label`**        | Used as a field label in the Admin panel and to name the generated GraphQL type.                                                                                                          |
| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                              |
| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. |
| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                              |
| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                             |
| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                |
| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                   |
| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                          |
| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                      |
| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                           |
| **`required`**     | Require this field to have a value.                                                                                                                                                       |
| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                 |
| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                 |

_\* An asterisk denotes that a property is required._

<Banner type="warning">
  <strong>Note:</strong> The Point field type is currently only supported in MongoDB.
</Banner>

### Example

`collections/ExampleCollection.ts`

```ts
import { CollectionConfig } from 'payload/types'

export const ExampleCollection: CollectionConfig = {
  slug: 'example-collection',
  fields: [
    {
      name: 'location',
      type: 'point',
      label: 'Location',
    },
  ],
}
```

### Querying

In order to do query based on the distance to another point, you can use the `near` operator. When querying using the near operator, the returned documents will be sorted by nearest first.
