---
title: "Gets a list of company_gateways"
method: GET
path: "/api/v1/company_gateways"
tags: ["company_gateways"]
---

# Gets a list of company_gateways

`GET /api/v1/company_gateways`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/company_gateways`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/company_gateways/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists company_gateways, search and filters allow fine grained lists to be generated.

        Query parameters can be added to performed more fine grained filtering of the company_gateways, these are handled by the CompanyGatewayFilters class which defines the methods available

## Query parameters

- `include` string
- `per_page` integer
- `page` integer
- `sort` string[]

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

A list of company_gateways

- object
  - `data` CompanyGateway[]
    - `id` string: The hashed id of the company gateway
    - `gateway_key` string: The gateway key (hash)
    - `accepted_credit_cards` integer: Bitmask representation of cards
    - `require_billing_address` boolean: Determines if the the billing address is required prior to payment.
    - `require_shipping_address` boolean: Determines if the the billing address is required prior to payment.
    - `config` string: The configuration map for the gateway
    - `update_details` boolean: Determines if the client details should be updated.
    - `fees_and_limits` FeesAndLimits[]: A mapped collection of the fees and limits for the configured gateway
      - `min_limit` string: The minimum amount accepted for this gateway
      - `max_limit` string: The maximum amount accepted for this gateway
      - `fee_amount` number, float: The gateway fee amount
      - `fee_percent` number, float: The gateway fee percentage
      - `fee_tax_name1` string: Fee tax name
      - `fee_tax_name2` string: Fee tax name
      - `fee_tax_name3` string: Fee tax name
      - `fee_tax_rate1` number, float: The tax rate
      - `fee_tax_rate2` number, float: The tax rate
      - `fee_tax_rate3` number, float: The tax rate
      - `fee_cap` number, float: If set the fee amount will be no higher than this amount
      - `adjust_fee_percent` boolean: Adjusts the fee to match the exact gateway fee.
  - `meta` Meta
    - `pagination` Pagination
      - `total` integer: The total number of items
      - `count` integer: The number of items per page
      - `per_page` integer: The number of items per page
      - `current_page` integer: The current page number
      - `total_pages` integer: The total number of pages
      - `links` object: The pagination links

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `429`: Rate Limit Exceeded
- `5XX`: Server error
- `default`: Unexpected Error

## Changes

- **2026-05-06** `89876e7e51d6`: 1 info
  - added the new optional `query` request parameter `sort`
- **2026-04-20** `69a36036d334`: 3 info
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `per_page`
  - the response optional property `data/items/id` became read-only for the status `200`
- **2025-05-24** `93bb427f804b`: 1 breaking
  - the `meta` response's property type changed from `object` to no type for status `200`
- **2024-06-06** `8e82a2bd77e0`: 2 breaking, 15 info
  - the response's body type changed from no type to `object` for status `default`
  - the `data/items/fees_and_limits/items/` response's property type changed from no type to `object` for status `200`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `data/items/fees_and_limits/items/adjust_fee_percent` to the response with the `200` status
  - …13 more
- **2024-06-05** `e61df65649e2`: 1 breaking, 3 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
  - removed the optional property `meta/pagination` from the response with the `200` status

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/company_gateways/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)