> For the complete documentation index, see [llms.txt](https://docs.geosamples.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geosamples.org/api/locations.md).

# Locations

## Map location clusters

> Low-zoom map clusters. Returns geohash aggregates as \`{ point: {lat, lon}, count }\` using the same sample filters as \`GET /api/samples/\`. Use \`bbox=min\_lon,min\_lat,max\_lon,max\_lat\`, \`precision\`, and \`size\`.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LocationClustersResponse":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"required":["count","data","status"]}}},"paths":{"/api/locations/":{"get":{"operationId":"locations_retrieve","description":"Low-zoom map clusters. Returns geohash aggregates as `{ point: {lat, lon}, count }` using the same sample filters as `GET /api/samples/`. Use `bbox=min_lon,min_lat,max_lon,max_lat`, `precision`, and `size`.","summary":"Map location clusters","parameters":[{"in":"query","name":"age_max","schema":{"type":"number","format":"float"},"description":"Upper bound on numeric age (`numeric_age_max` ≤ value)."},{"in":"query","name":"age_min","schema":{"type":"number","format":"float"},"description":"Lower bound on numeric age (`numeric_age_min` ≥ value)."},{"in":"query","name":"batch_history_id","schema":{"type":"integer"},"description":"Restrict to samples registered in this batch history PK (requires view permission on the batch)."},{"in":"query","name":"bbox","schema":{"type":"string"},"description":"WGS84 bounding box as `min_lon,min_lat,max_lon,max_lat`."},{"in":"query","name":"check_related_resource_id","schema":{"type":"integer"},"description":"Annotates rows linked to this related-resource primary key (used with list UI)."},{"in":"query","name":"collected_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `sampling_start_date` on or after this instant."},{"in":"query","name":"collected_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `sampling_end_date` on or before this instant."},{"in":"query","name":"collector","schema":{"type":"string"},"description":"Substring match on individual or institution collector label."},{"in":"query","name":"continent","schema":{"type":"string"},"description":"Continent code or label (exact field match on `continent`)."},{"in":"query","name":"country","schema":{"type":"string"},"description":"Country ISO 3166 code(s), comma-separated (e.g. `US,CA`)."},{"in":"query","name":"current_archive","schema":{"type":"string"},"description":"Substring match on current archive label or alt label."},{"in":"query","name":"depth_max","schema":{"type":"number","format":"float"},"description":"Samples with `depth_max` ≤ this value."},{"in":"query","name":"depth_min","schema":{"type":"number","format":"float"},"description":"Samples with `depth_min` ≥ this value."},{"in":"query","name":"description","schema":{"type":"string"},"description":"Case-insensitive substring match on `sample_description`."},{"in":"query","name":"elevation_max","schema":{"type":"number","format":"float"},"description":"Samples with `elevation` ≤ this value (meters)."},{"in":"query","name":"elevation_min","schema":{"type":"number","format":"float"},"description":"Samples with `elevation` ≥ this value (meters)."},{"in":"query","name":"exclude_child_samples","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only top-level samples (`parent_sample` empty)."},{"in":"query","name":"external_sample_id","schema":{"type":"string"},"description":"Exact match on `external_sample_id`."},{"in":"query","name":"field_name","schema":{"type":"string"},"description":"Case-insensitive match on material name verbatim (`material_name_verbatim`)."},{"in":"query","name":"format","schema":{"type":"string"},"description":"Reserved pass-through (same allowlist as list views)."},{"in":"query","name":"geographic_region","schema":{"type":"string"},"description":"Substring match across locality, province, location fields, etc."},{"in":"query","name":"geologic_age_unit","schema":{"type":"string"},"description":"Substring match on `geologic_age_verbatim` or `geologic_unit`."},{"in":"query","name":"has_age","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with non-null `numeric_age_min`, `numeric_age_max`, or `geologic_age_verbatim`."},{"in":"query","name":"has_geolocation","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with a non-null `geom_latlong`."},{"in":"query","name":"has_images","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with a related resource of type Image."},{"in":"query","name":"has_linked_resources","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, samples with linked resources excluding Image."},{"in":"query","name":"has_resource_type","schema":{"type":"string"},"description":"Exact case-insensitive related-resource type label (e.g. publication type labels)."},{"in":"query","name":"igsn","schema":{"type":"string"},"description":"Case-insensitive substring match on IGSN."},{"in":"query","name":"initiative","schema":{"type":"string"},"description":"Substring match on initiative label or normalized label linked as cruise/program."},{"in":"query","name":"initiative_id","schema":{"type":"integer"},"description":"Restrict to samples linked to this initiative PK (requires view permission on initiative)."},{"in":"query","name":"is_draft","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only drafts (authenticated, owner contexts). If `false`, exclude drafts."},{"in":"query","name":"launch_platform","schema":{"type":"string"},"description":"Substring match on launch platform label or normalized label."},{"in":"query","name":"launch_platform_id","schema":{"type":"integer"},"description":"Restrict to samples using this launch platform PK (requires view permission)."},{"in":"query","name":"material","schema":{"type":"string"},"description":"Comma-separated material type IDs; expands to descendants for FK and M2M material match."},{"in":"query","name":"name","schema":{"type":"string"},"description":"Case-insensitive substring match on sample name."},{"in":"query","name":"object_type","schema":{"type":"string"},"description":"Object type label(s); matches `object_type__in`."},{"in":"query","name":"ordering","schema":{"type":"string"},"description":"Sort field(s). Prefix `-` for descending (same as DRF `OrderingFilter`)."},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page number when using paginated list endpoints."},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"Page size when using paginated list endpoints."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Substring match on platform label or normalized label."},{"in":"query","name":"platform_id","schema":{"type":"integer"},"description":"Restrict to samples using this platform PK (requires view permission)."},{"in":"query","name":"point","schema":{"type":"string"},"description":"WKT POINT (`POINT(lon lat)`); use with optional `radius` (meters, default 1000)."},{"in":"query","name":"polygon","schema":{"type":"string"},"description":"WKT or GeoJSON geometry; samples with `geom_latlong` inside the polygon (SRID 4326 if omitted)."},{"in":"query","name":"precision","schema":{"type":"integer"},"description":"Geohash precision 1–12 for clusters (default 3)."},{"in":"query","name":"published_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `publish_date` ≥ this instant."},{"in":"query","name":"published_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `publish_date` ≤ this instant."},{"in":"query","name":"q","schema":{"type":"string"},"description":"Search substring matched against IGSN or name."},{"in":"query","name":"radius","schema":{"type":"number","format":"float"},"description":"Radius in meters around `point` (ignored without `point`)."},{"in":"query","name":"registered_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `registration_date` ≥ this instant."},{"in":"query","name":"registered_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `registration_date` ≤ this instant."},{"in":"query","name":"related_resource_id","schema":{"type":"integer"},"description":"Samples linked to this related resource PK (requires view permission)."},{"in":"query","name":"sample_group_id","schema":{"type":"integer"},"description":"Samples in this sample group PK (requires view permission on the group)."},{"in":"query","name":"sampling_method","schema":{"type":"string"},"description":"Case-insensitive match on linked sampling method label."},{"in":"query","name":"scope","schema":{"type":"string"},"description":"Visibility: `public` (published metadata), `personal` (your samples), `shared` (SESAR code grants), `personal_and_shared`; other values fall back to authenticated/public rules per server logic."},{"in":"query","name":"sesar_code","schema":{"type":"string"},"description":"SESAR code(s); matches `sesar_code__in`."},{"in":"query","name":"size","schema":{"type":"integer"},"description":"Max clusters / groups / point rows to return."},{"in":"query","name":"team_name","schema":{"type":"string"},"description":"Restrict to samples owned by this team (must be authenticated member)."}],"tags":["Locations"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationClustersResponse"}}},"description":""},"400":{"description":"Invalid spatial parameters"}}}}}}
```

## Samples near a map click

> Detail rows near a clicked map coordinate. Requires \`point=POINT(lon lat)\` and optional \`radius\` in meters.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LocationPointResponse":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"required":["count","data","status"]}}},"paths":{"/api/locations/point/":{"get":{"operationId":"locations_point_retrieve","description":"Detail rows near a clicked map coordinate. Requires `point=POINT(lon lat)` and optional `radius` in meters.","summary":"Samples near a map click","parameters":[{"in":"query","name":"age_max","schema":{"type":"number","format":"float"},"description":"Upper bound on numeric age (`numeric_age_max` ≤ value)."},{"in":"query","name":"age_min","schema":{"type":"number","format":"float"},"description":"Lower bound on numeric age (`numeric_age_min` ≥ value)."},{"in":"query","name":"batch_history_id","schema":{"type":"integer"},"description":"Restrict to samples registered in this batch history PK (requires view permission on the batch)."},{"in":"query","name":"bbox","schema":{"type":"string"},"description":"WGS84 bounding box as `min_lon,min_lat,max_lon,max_lat`."},{"in":"query","name":"check_related_resource_id","schema":{"type":"integer"},"description":"Annotates rows linked to this related-resource primary key (used with list UI)."},{"in":"query","name":"collected_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `sampling_start_date` on or after this instant."},{"in":"query","name":"collected_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `sampling_end_date` on or before this instant."},{"in":"query","name":"collector","schema":{"type":"string"},"description":"Substring match on individual or institution collector label."},{"in":"query","name":"continent","schema":{"type":"string"},"description":"Continent code or label (exact field match on `continent`)."},{"in":"query","name":"country","schema":{"type":"string"},"description":"Country ISO 3166 code(s), comma-separated (e.g. `US,CA`)."},{"in":"query","name":"current_archive","schema":{"type":"string"},"description":"Substring match on current archive label or alt label."},{"in":"query","name":"depth_max","schema":{"type":"number","format":"float"},"description":"Samples with `depth_max` ≤ this value."},{"in":"query","name":"depth_min","schema":{"type":"number","format":"float"},"description":"Samples with `depth_min` ≥ this value."},{"in":"query","name":"description","schema":{"type":"string"},"description":"Case-insensitive substring match on `sample_description`."},{"in":"query","name":"elevation_max","schema":{"type":"number","format":"float"},"description":"Samples with `elevation` ≤ this value (meters)."},{"in":"query","name":"elevation_min","schema":{"type":"number","format":"float"},"description":"Samples with `elevation` ≥ this value (meters)."},{"in":"query","name":"exclude_child_samples","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only top-level samples (`parent_sample` empty)."},{"in":"query","name":"external_sample_id","schema":{"type":"string"},"description":"Exact match on `external_sample_id`."},{"in":"query","name":"field_name","schema":{"type":"string"},"description":"Case-insensitive match on material name verbatim (`material_name_verbatim`)."},{"in":"query","name":"format","schema":{"type":"string"},"description":"Reserved pass-through (same allowlist as list views)."},{"in":"query","name":"geographic_region","schema":{"type":"string"},"description":"Substring match across locality, province, location fields, etc."},{"in":"query","name":"geologic_age_unit","schema":{"type":"string"},"description":"Substring match on `geologic_age_verbatim` or `geologic_unit`."},{"in":"query","name":"has_age","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with non-null `numeric_age_min`, `numeric_age_max`, or `geologic_age_verbatim`."},{"in":"query","name":"has_geolocation","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with a non-null `geom_latlong`."},{"in":"query","name":"has_images","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with a related resource of type Image."},{"in":"query","name":"has_linked_resources","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, samples with linked resources excluding Image."},{"in":"query","name":"has_resource_type","schema":{"type":"string"},"description":"Exact case-insensitive related-resource type label (e.g. publication type labels)."},{"in":"query","name":"igsn","schema":{"type":"string"},"description":"Case-insensitive substring match on IGSN."},{"in":"query","name":"initiative","schema":{"type":"string"},"description":"Substring match on initiative label or normalized label linked as cruise/program."},{"in":"query","name":"initiative_id","schema":{"type":"integer"},"description":"Restrict to samples linked to this initiative PK (requires view permission on initiative)."},{"in":"query","name":"is_draft","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only drafts (authenticated, owner contexts). If `false`, exclude drafts."},{"in":"query","name":"launch_platform","schema":{"type":"string"},"description":"Substring match on launch platform label or normalized label."},{"in":"query","name":"launch_platform_id","schema":{"type":"integer"},"description":"Restrict to samples using this launch platform PK (requires view permission)."},{"in":"query","name":"material","schema":{"type":"string"},"description":"Comma-separated material type IDs; expands to descendants for FK and M2M material match."},{"in":"query","name":"name","schema":{"type":"string"},"description":"Case-insensitive substring match on sample name."},{"in":"query","name":"object_type","schema":{"type":"string"},"description":"Object type label(s); matches `object_type__in`."},{"in":"query","name":"ordering","schema":{"type":"string"},"description":"Sort field(s). Prefix `-` for descending (same as DRF `OrderingFilter`)."},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page number when using paginated list endpoints."},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"Page size when using paginated list endpoints."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Substring match on platform label or normalized label."},{"in":"query","name":"platform_id","schema":{"type":"integer"},"description":"Restrict to samples using this platform PK (requires view permission)."},{"in":"query","name":"point","schema":{"type":"string"},"description":"WKT POINT (`POINT(lon lat)`); use with optional `radius` (meters, default 1000)."},{"in":"query","name":"polygon","schema":{"type":"string"},"description":"WKT or GeoJSON geometry; samples with `geom_latlong` inside the polygon (SRID 4326 if omitted)."},{"in":"query","name":"precision","schema":{"type":"integer"},"description":"Geohash precision 1–12 for clusters (default 3)."},{"in":"query","name":"published_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `publish_date` ≥ this instant."},{"in":"query","name":"published_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `publish_date` ≤ this instant."},{"in":"query","name":"q","schema":{"type":"string"},"description":"Search substring matched against IGSN or name."},{"in":"query","name":"radius","schema":{"type":"number","format":"float"},"description":"Radius in meters around `point` (ignored without `point`)."},{"in":"query","name":"registered_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `registration_date` ≥ this instant."},{"in":"query","name":"registered_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `registration_date` ≤ this instant."},{"in":"query","name":"related_resource_id","schema":{"type":"integer"},"description":"Samples linked to this related resource PK (requires view permission)."},{"in":"query","name":"sample_group_id","schema":{"type":"integer"},"description":"Samples in this sample group PK (requires view permission on the group)."},{"in":"query","name":"sampling_method","schema":{"type":"string"},"description":"Case-insensitive match on linked sampling method label."},{"in":"query","name":"scope","schema":{"type":"string"},"description":"Visibility: `public` (published metadata), `personal` (your samples), `shared` (SESAR code grants), `personal_and_shared`; other values fall back to authenticated/public rules per server logic."},{"in":"query","name":"sesar_code","schema":{"type":"string"},"description":"SESAR code(s); matches `sesar_code__in`."},{"in":"query","name":"size","schema":{"type":"integer"},"description":"Max clusters / groups / point rows to return."},{"in":"query","name":"team_name","schema":{"type":"string"},"description":"Restrict to samples owned by this team (must be authenticated member)."}],"tags":["Locations"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationPointResponse"}}},"description":""},"400":{"description":"Missing or invalid spatial parameters"}}}}}}
```

## Map location sample groups

> Higher-zoom location markers grouped by parent/root sample. Each group includes nested sample stubs and a representative point.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]},{}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LocationSamplesResponse":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"required":["count","data","status"]}}},"paths":{"/api/locations/samples/":{"get":{"operationId":"locations_samples_retrieve","description":"Higher-zoom location markers grouped by parent/root sample. Each group includes nested sample stubs and a representative point.","summary":"Map location sample groups","parameters":[{"in":"query","name":"age_max","schema":{"type":"number","format":"float"},"description":"Upper bound on numeric age (`numeric_age_max` ≤ value)."},{"in":"query","name":"age_min","schema":{"type":"number","format":"float"},"description":"Lower bound on numeric age (`numeric_age_min` ≥ value)."},{"in":"query","name":"batch_history_id","schema":{"type":"integer"},"description":"Restrict to samples registered in this batch history PK (requires view permission on the batch)."},{"in":"query","name":"bbox","schema":{"type":"string"},"description":"WGS84 bounding box as `min_lon,min_lat,max_lon,max_lat`."},{"in":"query","name":"check_related_resource_id","schema":{"type":"integer"},"description":"Annotates rows linked to this related-resource primary key (used with list UI)."},{"in":"query","name":"collected_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `sampling_start_date` on or after this instant."},{"in":"query","name":"collected_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `sampling_end_date` on or before this instant."},{"in":"query","name":"collector","schema":{"type":"string"},"description":"Substring match on individual or institution collector label."},{"in":"query","name":"continent","schema":{"type":"string"},"description":"Continent code or label (exact field match on `continent`)."},{"in":"query","name":"country","schema":{"type":"string"},"description":"Country ISO 3166 code(s), comma-separated (e.g. `US,CA`)."},{"in":"query","name":"current_archive","schema":{"type":"string"},"description":"Substring match on current archive label or alt label."},{"in":"query","name":"depth_max","schema":{"type":"number","format":"float"},"description":"Samples with `depth_max` ≤ this value."},{"in":"query","name":"depth_min","schema":{"type":"number","format":"float"},"description":"Samples with `depth_min` ≥ this value."},{"in":"query","name":"description","schema":{"type":"string"},"description":"Case-insensitive substring match on `sample_description`."},{"in":"query","name":"elevation_max","schema":{"type":"number","format":"float"},"description":"Samples with `elevation` ≤ this value (meters)."},{"in":"query","name":"elevation_min","schema":{"type":"number","format":"float"},"description":"Samples with `elevation` ≥ this value (meters)."},{"in":"query","name":"exclude_child_samples","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only top-level samples (`parent_sample` empty)."},{"in":"query","name":"external_sample_id","schema":{"type":"string"},"description":"Exact match on `external_sample_id`."},{"in":"query","name":"field_name","schema":{"type":"string"},"description":"Case-insensitive match on material name verbatim (`material_name_verbatim`)."},{"in":"query","name":"format","schema":{"type":"string"},"description":"Reserved pass-through (same allowlist as list views)."},{"in":"query","name":"geographic_region","schema":{"type":"string"},"description":"Substring match across locality, province, location fields, etc."},{"in":"query","name":"geologic_age_unit","schema":{"type":"string"},"description":"Substring match on `geologic_age_verbatim` or `geologic_unit`."},{"in":"query","name":"has_age","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with non-null `numeric_age_min`, `numeric_age_max`, or `geologic_age_verbatim`."},{"in":"query","name":"has_geolocation","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with a non-null `geom_latlong`."},{"in":"query","name":"has_images","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only samples with a related resource of type Image."},{"in":"query","name":"has_linked_resources","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, samples with linked resources excluding Image."},{"in":"query","name":"has_resource_type","schema":{"type":"string"},"description":"Exact case-insensitive related-resource type label (e.g. publication type labels)."},{"in":"query","name":"igsn","schema":{"type":"string"},"description":"Case-insensitive substring match on IGSN."},{"in":"query","name":"initiative","schema":{"type":"string"},"description":"Substring match on initiative label or normalized label linked as cruise/program."},{"in":"query","name":"initiative_id","schema":{"type":"integer"},"description":"Restrict to samples linked to this initiative PK (requires view permission on initiative)."},{"in":"query","name":"is_draft","schema":{"type":"string","enum":["false","true"]},"description":"If `true`, only drafts (authenticated, owner contexts). If `false`, exclude drafts."},{"in":"query","name":"launch_platform","schema":{"type":"string"},"description":"Substring match on launch platform label or normalized label."},{"in":"query","name":"launch_platform_id","schema":{"type":"integer"},"description":"Restrict to samples using this launch platform PK (requires view permission)."},{"in":"query","name":"material","schema":{"type":"string"},"description":"Comma-separated material type IDs; expands to descendants for FK and M2M material match."},{"in":"query","name":"name","schema":{"type":"string"},"description":"Case-insensitive substring match on sample name."},{"in":"query","name":"object_type","schema":{"type":"string"},"description":"Object type label(s); matches `object_type__in`."},{"in":"query","name":"ordering","schema":{"type":"string"},"description":"Sort field(s). Prefix `-` for descending (same as DRF `OrderingFilter`)."},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page number when using paginated list endpoints."},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"Page size when using paginated list endpoints."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Substring match on platform label or normalized label."},{"in":"query","name":"platform_id","schema":{"type":"integer"},"description":"Restrict to samples using this platform PK (requires view permission)."},{"in":"query","name":"point","schema":{"type":"string"},"description":"WKT POINT (`POINT(lon lat)`); use with optional `radius` (meters, default 1000)."},{"in":"query","name":"polygon","schema":{"type":"string"},"description":"WKT or GeoJSON geometry; samples with `geom_latlong` inside the polygon (SRID 4326 if omitted)."},{"in":"query","name":"precision","schema":{"type":"integer"},"description":"Geohash precision 1–12 for clusters (default 3)."},{"in":"query","name":"published_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `publish_date` ≥ this instant."},{"in":"query","name":"published_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `publish_date` ≤ this instant."},{"in":"query","name":"q","schema":{"type":"string"},"description":"Search substring matched against IGSN or name."},{"in":"query","name":"radius","schema":{"type":"number","format":"float"},"description":"Radius in meters around `point` (ignored without `point`)."},{"in":"query","name":"registered_after","schema":{"type":"string","format":"date-time"},"description":"Samples with `registration_date` ≥ this instant."},{"in":"query","name":"registered_before","schema":{"type":"string","format":"date-time"},"description":"Samples with `registration_date` ≤ this instant."},{"in":"query","name":"related_resource_id","schema":{"type":"integer"},"description":"Samples linked to this related resource PK (requires view permission)."},{"in":"query","name":"sample_group_id","schema":{"type":"integer"},"description":"Samples in this sample group PK (requires view permission on the group)."},{"in":"query","name":"sampling_method","schema":{"type":"string"},"description":"Case-insensitive match on linked sampling method label."},{"in":"query","name":"scope","schema":{"type":"string"},"description":"Visibility: `public` (published metadata), `personal` (your samples), `shared` (SESAR code grants), `personal_and_shared`; other values fall back to authenticated/public rules per server logic."},{"in":"query","name":"sesar_code","schema":{"type":"string"},"description":"SESAR code(s); matches `sesar_code__in`."},{"in":"query","name":"size","schema":{"type":"integer"},"description":"Max clusters / groups / point rows to return."},{"in":"query","name":"team_name","schema":{"type":"string"},"description":"Restrict to samples owned by this team (must be authenticated member)."}],"tags":["Locations"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationSamplesResponse"}}},"description":""},"400":{"description":"Invalid spatial parameters"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.geosamples.org/api/locations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.