# List gateways

`GET https://app.shuttleglobal.com/c/api/instances/{instance_key}/gateways`

List and search gateways for an instance.

Available search fields:
* `id`: Gateway ID
* `code`: Your gateway reference
* `created`: Creation timestamp
* `division`: Division ID
* `processor`: Processor type (e.g., STRIPE)
* `status`: Gateway status
* `updated`: Last update timestamp

Expandable fields:
* `authenticate_js`: JavaScript for express checkout
* `checkout_js`: JavaScript for normal checkout
* `credit_message_js`: JavaScript for credit messages
* `created_session`: Creation session details
* `processor`: Processor details
* `updated_session`: Update session details

## Authentication

- basicAuth: Basic Authentication using secret key
- bearerAuth: OAuth 2.0 Bearer Token Authentication

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `criteria` | query | string | no | Search criteria for filtering gateways. Available fields: - id - code - created - division - processor - status - updated Examples: - `status=ACTIVE` - `processor=STRIPE` |
| `order` | query | string | no | Sort order for results. Supports any field that criteria supports. Defaults to `created:desc` if not specified. Append `:desc` for descending order. |
| `expand` | query | string | no | Fields to expand into full objects. Separate multiple fields with commas. Available fields: - authenticate_js (JavaScript for express checkout) - checkout_js (JavaScript for normal checkout) - credit_message_js (JavaScript for credit messages) - created_session (session object) - processor (processor details) - updated_session (session object) |
| `limit` | query | integer | no | Number of records to return: 20 if not set, at most 1000. |
| `offset` | query | integer | no | Number of records to skip before the first one returned. `offset` + `limit` can't exceed 5000; to read further, page by a field such as `created` instead. See [Paging through results](/platforms/reference/paging/). |

## Responses

### 200: List of gateways

```json
{
  "gateways": [
    {
      "id": "string",
      "name": "string",
      "code": "string",
      "division": "string",
      "status": "CREATED",
      "status_reason": "string",
      "processor": "string",
      "processor_name": "string",
      "processor_account_name": "string",
      "gateway_group": "string",
      "currencies": [
        "string"
      ],
      "payment_method_types": {},
      "payment_method_types_moto": {},
      "metadata": {},
      "tags": [
        "string"
      ],
      "features": {},
      "created": "2026-01-01T12:00:00Z",
      "created_session": "string",
      "updated": "2026-01-01T12:00:00Z",
      "updated_session": "string",
      "v": 0
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}
```

### 400: Bad request - invalid parameters

```json
{
  "code": "string",
  "message": "string"
}
```

### 401: Unauthorized - invalid credentials

```json
{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}
```

## Example request

```sh
curl --request GET \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/gateways \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>'
```

Reference page: https://docs.shuttleglobal.com/platforms/reference/operations/listgateways/