> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List service areas

> Retrieve a paginated list of service areas.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const serviceAreaList = await site.serviceAreas().listServiceAreas()
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "mode": "zips",
      "priority": 0,
      "active": true,
      "zipCodes": "Example zip codes",
      "shapes": [
        {
          "id": "clx8m2k4p0000a1b2c3d4e5f6",
          "path": [
            {}
          ]
        }
      ],
      "slug": "example-slug",
      "visibility": "public",
      "scheduledPublish": "Example scheduled publish",
      "scheduledUnpublish": "Example scheduled unpublish",
      "price": 0,
      "priceLabel": "Example price label",
      "color": "Example color",
      "description": "Example description",
      "publicNames": [],
      "source": "manual",
      "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
      "archived": false,
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

A controller answers a route on your app: it calls `listServiceAreas()` and returns the answer.

**1. Add the controller**

```ts app/controllers/list_service_areas_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListServiceAreasController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.serviceAreas().listServiceAreas()
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ListServiceAreasController = () => import('#controllers/list_service_areas_controller')

router.get('/service-area', [ListServiceAreasController])
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:3333/service-area
```

With `node ace serve` running, it prints its answer as JSON.

> [accordion] Optional parameters
>
> One object, e.g. `listServiceAreas({ page })`; leave out the optional fields.
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `number | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1.
>
> **search** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

> [accordion] Returns
>
> A `ServiceAreaList`. A page of ServiceArea documents. Read its properties (`serviceAreaList.results`): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (`_id` → `id`).
>
> **results** `readonly ServiceArea[]`
>
> **Always sent.** A list of `ServiceArea`. This page’s documents; empty past the last page.
>
> **ServiceArea**
>
> ServiceArea content type
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **id** `string`
>
> **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **mode** `Mode | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How is this area defined? One of `zips`, `polygon`; a newer site may send others, so keep a fallback.
>
> **priority** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Sort position — and where areas overlap, the LOWEST number wins the click/search result.
>
> **active** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Turn off to keep the area saved but leave it off the map.
>
> **zipCodes** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. One or more 5-digit zip codes, separated by commas, spaces or new lines. The map shape is generated automatically from public zip-boundary data.
>
> **shapes** `readonly ServiceAreaShapesItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `ServiceAreaShapesItem`. One or more shapes for this area. Paste coordinates (or draw on the map once a Google Maps key is configured); each shape needs at least 3 points.
>
> **ServiceAreaShapesItem**
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The shape’s id. Leave it out for a new shape (the site sets one).
>
> **path** `readonly ServiceAreaShapesItemPathItem[]`
>
> **Sometimes sent:** `undefined` when the site leaves it out. A list of `ServiceAreaShapesItemPathItem`. The ring’s points, in order (at least 3).
>
> **ServiceAreaShapesItemPathItem**
>
> **lat** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Latitude in degrees (kept to 6 decimals). -90 to 90.
>
> **lng** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Longitude in degrees (kept to 6 decimals). -180 to 180.
>
> **slug** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `Visibility | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **price** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The amount shown for this area (0 shows the map section’s “included” label). Use the label below for anything non-standard.
>
> **priceLabel** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Shown instead of the formatted price — e.g. “From \$40” or “Call for pricing”.
>
> **color** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty to assign a color from the site palette automatically.
>
> **description** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional short text shown when a visitor clicks this area (or finds it via search).
>
> **publicNames** `readonly ServiceAreaPublicNamesItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `ServiceAreaPublicNamesItem`. Optional. The real-world places this area covers — e.g. “Brooklyn” or “Albany County”. Zone names like “Zone A” mean nothing to search engines; these names are what gets published as structured data (with structured data enabled in Site settings → SEO).
>
> **ServiceAreaPublicNamesItem**
>
> **name** `string`
>
> **Always sent.** Place name.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **placeType** `PlaceType | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Pick the closest match — search engines read each entry as its own schema.org type. One of `City`, `AdministrativeArea`, `State`, `Place`; a newer site may send others, so keep a fallback.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **source** `ServiceAreaSource | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set automatically. “Demo placeholder” rows are removed the moment a real service area is published. “Zip feed import” rows were created by Import Zones from Zip Feed and get their zips/price refreshed on re-import. One of `manual`, `demo`, `zipFeed`; a newer site may send others, so keep a fallback.
>
> **sourceId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Internal id of the seed/import that created this row. Empty for manually created areas.
>
> **archived** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **createdAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.
>
> **pages** `number`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `number`
>
> **Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:service-areas:read` (or a master above it: `content:service-areas:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:service-areas:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) in `config/attract.ts` for longer.
* **Paging:** one page per call. To walk them all, use `listServiceAreasAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listServiceAreasAll()` takes `listServiceAreas()`’s arguments except `page`. `listServiceAreasPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields.

```ts Every page wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const serviceArea of site.serviceAreas().listServiceAreasAll()) {
  console.log(serviceArea) // the next page is fetched as you iterate
}
```

```ts Only some fields wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const rows = await site.serviceAreas().listServiceAreasPick(['title', 'slug']) // [{ id, title, slug }, …]: every service area, across every page
```

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/service_areas_list_service_areas.spec.ts`, then run your tests:

```ts tests/unit/service_areas_list_service_areas.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListServiceAreasController from '#controllers/list_service_areas_controller'

test('serviceAreas.listServiceAreas', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListServiceAreasController)
  await controller.handle()

  site.assertCalled('serviceAreas.listServiceAreas')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `serviceAreas.listServiceAreas` with a `sequence()` of pages, each `factories.ServiceAreaList({...})`, and walk `listServiceAreasAll()`.

```ts tests/unit/service_areas_list_service_areas_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

test('serviceAreas.listServiceAreas answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'serviceAreas.listServiceAreas': sequence(
      factories.ServiceAreaList({ currentPage: 1, pages: 2 }),
      factories.ServiceAreaList({ currentPage: 2, pages: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const serviceArea of site.serviceAreas().listServiceAreasAll()) {
    walked.push(serviceArea)
  }
  assert.lengthOf(walked, 2)
})
```

To fake `listServiceAreasAll()`, answer `serviceAreas.listServiceAreas` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List a service area’s locales](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/get-service-area-locales.md)
>
> `site.serviceAreas().getServiceAreaLocales()`

> [card] [Create a service area](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/create-service-area.md)
>
> `site.serviceAreas().createServiceArea()`

> [card] [Get a service area](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/get-service-area.md)
>
> `site.serviceAreas().getServiceArea()`

> [card] [Replace a service area](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/replace-service-area.md)
>
> `site.serviceAreas().replaceServiceArea()`

> [card] [Delete a service area](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/delete-service-area.md)
>
> `site.serviceAreas().deleteServiceArea()`

> [card] [Update a service area](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/update-service-area.md)
>
> `site.serviceAreas().updateServiceArea()`

> [card] [GET /service-area](https://docs.fetchski-attract.com/api-reference/service-areas/list-service-areas.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.