> For the complete documentation index, see [llms.txt](https://docs.sync.comake.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sync.comake.io/api-reference/madden-places.md).

# Madden Places

## Overview

The Madden Places API provides access to place (venue/location) data managed within ACVB's TourismOS platform. Each place returned through this API has a corresponding Simpleview Account Number, making it straightforward to match records with ACVB's Simpleview CRM system.

Along with core place information, the API also returns any related editorial articles associated with each place, giving a complete picture of both the venue and the content written about it.

***

## API Endpoint

**URL:** `https://acvb.standard.storage/api/custom/madden/places`

**Method:** POST

**Authentication:** Bearer token required in the Authorization header.

***

## Request Parameters

The request body accepts the following options:

| Parameter  | Required | Description                                                                                            |
| ---------- | -------- | ------------------------------------------------------------------------------------------------------ |
| **limit**  | No       | How many places to return in a single request. Defaults to 10. Maximum is 50.                          |
| **offset** | No       | How many places to skip before returning results, useful for paging through large sets. Defaults to 0. |

***

## Response Structure

The response includes:

| Field         | Description                                                                                                                               |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| **places**    | The list of place records, each with its related articles included.                                                                       |
| **offset**    | The offset value used for the current page of results.                                                                                    |
| **limit**     | The limit value used for the current page of results.                                                                                     |
| **has\_more** | Indicates whether additional results may exist beyond the current page. When this is true, increase the offset to retrieve the next page. |

Results are always returned with the most recently created places first.

***

## Data Provided

### Place

A **Place** represents a physical location that visitors can experience — such as a venue, attraction, restaurant, shop, park, or hotel. Every place returned by this API is linked to a Simpleview Account Number in ACVB's CRM.

Each place record includes the following information:

| Field                         | Description                                                                                                                                                                                               |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ID**                        | A unique identifier for the place within TourismOS.                                                                                                                                                       |
| **Type**                      | Identifies this record as a Place.                                                                                                                                                                        |
| **Simpleview Account Number** | The corresponding account number in ACVB's Simpleview CRM system. This field is always present on every place returned by this API, and serves as the primary key for matching records between systems.   |
| **Name**                      | The display name of the place (e.g., "Cadence Bank Amphitheatre at Chastain Park").                                                                                                                       |
| **Description**               | A plain-text summary describing the place — what it is, what visitors can expect, and what makes it notable.                                                                                              |
| **Rich Description**          | A more detailed editorial description of the place, which may include formatted text with headings, lists, and emphasis. Intended for use in content-rich displays such as landing pages or detail views. |
| **Operational Status**        | The current operating status of the place, such as "Open", "Closed", or "Temporarily Closed". Useful for filtering or flagging places that may not currently be available to visitors.                    |
| **Date Created**              | When the place record was first created in TourismOS.                                                                                                                                                     |
| **Date Modified**             | When the place record was last updated.                                                                                                                                                                   |
| **Articles**                  | A list of related editorial articles associated with this place. See the Article section below for details. If no articles are related to a place, this will be an empty list.                            |

***

### Article

An **Article** represents editorial or informational content — such as guides, listicles, or stories — authored by the DMO or its partners. Articles describe, recommend, or provide context about places, events, or areas. They are narrative content *about* places rather than the place records themselves.

Each article included with a place contains the following information:

| Field              | Description                                                                                                       |
| ------------------ | ----------------------------------------------------------------------------------------------------------------- |
| **ID**             | A unique identifier for the article within TourismOS.                                                             |
| **Type**           | Identifies this record as an Article.                                                                             |
| **Headline**       | The title of the article (e.g., "Your Guide to Chastain Park").                                                   |
| **Abstract**       | A short summary of the article's content, suitable for use as a preview or teaser in listings and search results. |
| **Article Body**   | The full text of the article. May include formatted content with headings, lists, and emphasis.                   |
| **URL**            | A web link to the published version of the article.                                                               |
| **Date Published** | When the article was officially published.                                                                        |
| **Date Created**   | When the article record was first created in TourismOS.                                                           |
| **Date Modified**  | When the article record was last updated.                                                                         |

***

## Pagination

To retrieve all available places, start with offset 0 and your desired limit. If the response returns `has_more` as true, send another request with the offset increased by the limit value. Repeat until `has_more` is false.

For example, with a limit of 10:

* First request: offset 0 — returns places 1 through 10
* Second request: offset 10 — returns places 11 through 20
* Continue until `has_more` is false

***

## Important Notes

* Only places that have a **Simpleview Account Number** assigned are included in the results. Places without this identifier are excluded.
* Each place is enriched with its related articles. If articles cannot be retrieved for a particular place, that place is still returned with an empty articles list — it does not cause the entire request to fail.
* All date and time values are provided in ISO 8601 format with UTC timezone (e.g., "2023-05-01T10:00:00.000Z").
