# Get markets

> Retrieve all available markets for the company

Breadcrumb: API v1 › Get markets · Status: Legacy
Docs index: https://docs.cevoid.com/developers/llms.txt

`GET https://api.cevoid.com/v1/markets`

Retrieve all available markets for the company

## Authorizations

API key in the x-api-key header: `x-api-key: <key>`.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `number` | No | Max value for limit is 25 Default: `25`. Range: `1 <= x <= 25`. Example: `10`. |
| `skip` | `number \| null` | No | Number of items to skip Default: `0`. Range: `0 <= x`. Example: `0`. |

## Response

### 200: Successful response

`application/json`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `count` | `number` | Yes | Total number of items |
| `next` | `string \| null` | Yes | URL for next page |
| `nodes` | `object[]` | Yes |  |
| `nodes[].id` | `string` | Yes | Unique identifier for the market within the Cevoid system Example: `market_us_123abc`. |
| `nodes[].shortId` | `string` | Yes | Shortened, human-readable identifier for the market, typically used in URLs and API calls Example: `us`. |
| `nodes[].title` | `string` | Yes | Display name of the market, typically representing the country or region Example: `United States`. |
| `nodes[].customId` | `string` | No | Custom identifier for the market, alternative to shortId Example: `us-market`. |
| `nodes[].country` | `string` | Yes | ISO 3166-1 alpha-2 country code representing the geographic market location Example: `US`. |
| `nodes[].currency` | `string` | Yes | ISO 4217 currency code used for pricing and transactions within this market Example: `USD`. |
| `nodes[].language` | `string` | Yes | ISO 639-1 language code representing the primary language for content and communications in this market Example: `en`. |
| `nodes[].domain` | `string` | Yes | Primary domain URL or website associated with this market, used for e-commerce store integration Example: `https://store.example.com`. |
| `nodes[].default` | `boolean` | Yes | Indicates whether this market serves as the default/fallback market when no specific market is selected Example: `true`. |
| `nodes[].settings` | `any \| null` | No | Market-specific configuration and settings object Example: `{}`. |
| `nodes[].createdAt` | `string` | Yes | ISO 8601 timestamp indicating when this market was first created in the system Example: `2024-01-10T08:00:00.000Z`. |
| `nodes[].updatedAt` | `string` | Yes | ISO 8601 timestamp indicating when this market was last updated Example: `2024-01-15T12:45:30.000Z`. |

```json
{
  "count": 0,
  "next": "string",
  "nodes": [
    {
      "id": "market_us_123abc",
      "shortId": "us",
      "title": "United States",
      "customId": "us-market",
      "country": "US",
      "currency": "USD",
      "language": "en",
      "domain": "https://store.example.com",
      "default": true,
      "settings": {},
      "createdAt": "2024-01-10T08:00:00.000Z",
      "updatedAt": "2024-01-15T12:45:30.000Z"
    }
  ]
}
```

### 400: Bad request

`application/json`

Type: `string`.

```json
"string"
```

### 401: Unauthorized

`application/json`

Type: `enum<string>`. Allowed value: `No valid API key provided`.

```json
"No valid API key provided"
```

### 500: Internal server error

`application/json`

Type: `enum<string>`. Allowed value: `Something went wrong`.

```json
"Something went wrong"
```

## Request example

```bash
curl 'https://api.cevoid.com/v1/markets' \
  -H "x-api-key: ${CEVOID_API_KEY}"
```

---

Canonical: https://docs.cevoid.com/developers/api/v1/markets/get-markets
