---
title: "List"
method: GET
path: "/api/cp/carrier"
tags: ["Carrier"]
---

# List

`GET /api/cp/carrier`

Retrieve a paginated list of Carrier records. Supports filtering, sorting, and search.

## Query parameters

- `status` string
- `p_asserted_identity` 'default' | 'remove' | 'if-available' | 'required'
- `invoice_schedule` 'day' | 'week' | 'bimonth' | 'month' | 'disabled'
- `default_stir_shaken_attestation` 'A' | 'B' | 'C'

## Response `200`

Successful response

- Carrier[]
  - `id` integer — Id
  - `account_id` integer — Account Id
  - `reseller_id` integer — Reseller Id
  - `name` string — Name
  - `alias` string — Alias
  - `channels` integer — Channels
  - `cps` number — Cps
  - `system_id` string — System Id
  - `status` string — Status
  - `address1` string — Address 1
  - `address2` string — Address 2
  - `city` string — City
  - `county` string — County
  - `postcode` string — Postcode
  - `website` string, uri — Website
  - `country` string — Country
  - `credit_refresh_interval` integer — Credit Refresh Interval
  - `portal_json` string — Portal Json
  - `portal_url` string, uri — Portal Url
  - `portal_username` string — Portal Username
  - `portal_password` string, password — Portal Password
  - `email_credit_regex` string — Email Credit Regex
  - `trace` integer — Trace
  - `credit` number — Credit
  - `debit_limit` number — Debit Limit
  - `tax` number — Tax
  - `snapshot_credit` number — Snapshot Credit
  - `snapshot_timestamp` integer — Snapshot Timestamp
  - `currency` string — Currency
  - `paypal` string — Paypal
  - `portal_access` string — Portal Access
  - `is_customer` integer — Is Customer
  - `is_carrier` integer — Is Carrier
  - `last_call` integer, nullable — Last Call
  - `auto_login_key` string — Auto Login Key
  - `connexcs_permission` string — Connexcs Permission
  - `fr_timeout` integer — Fr Timeout
  - `pre_ring_timeout` integer — Pre Ring Timeout
  - `post_ring_timeout` integer — Post Ring Timeout
  - `p_asserted_identity` 'default' | 'remove' | 'if-available' | 'required' — P Asserted Identity
  - `reply_actions` object — Reply Actions
  - `reply_actions_json` object — Reply Actions Json
  - `did_api_id` string — Did Api Id
  - `account_api_id` string — Account Api Id
  - `resources_used` string, binary — Resources Used
  - `code_consistency` number — Code Consistency
  - `code_consistency_points` number — Code Consistency Points
  - `min_payment` number — Min Payment
  - `approved_cli_only` integer — Approved Cli Only
  - `invoice_schedule` 'day' | 'week' | 'bimonth' | 'month' | 'disabled' — Invoice Schedule
  - `invoice_due_days` integer — Invoice Due Days
  - `propagate_username` integer — Propagate Username
  - `required` string[] — Required
  - `duration_latency_offset` number — Duration Latency Offset
  - `notes` string — Notes
  - `consec_backoff` integer — Consec Backoff
  - `tags` string — Tags
  - `vars` string — Vars
  - `topup_currencies` string — Topup Currencies
  - `accounting_id` string — Accounting Id
  - `invoice_template` string — Invoice Template
  - `account_manager_id` integer — Account Manager Id
  - `origid` string — Origid
  - `rtp_firewall_warning` integer — Rtp Firewall Warning
  - `s3_size` number — S 3 Size
  - `call_recording_retention_days` integer — Call Recording Retention Days
  - `range_holder_provider_card_id` string — Range Holder Provider Card Id
  - `domain_id` integer — Domain Id
  - `cx_referal` integer — Cx Referal
  - `max_daily_spend` number — Max Daily Spend
  - `dt_restrict` object — Dt Restrict
  - `default_stir_shaken_attestation` 'A' | 'B' | 'C' — Default Stir Shaken Attestation
  - `flags` string — Flags

## Other responses

- `400` — Bad Request - Invalid parameters or request body
- `401` — Authentication information is missing or invalid
- `403` — Access denied - insufficient permissions or dependency access failure
- `500` — Internal server error

---

[API](https://skmtc.dev/connexcs/apis/connexcs-control-panel-api.md) · [All operations](https://skmtc.dev/connexcs/apis/connexcs-control-panel-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/connexcs/connexcs-control-panel-api/revisions/54bc2ed6edae/schema)
