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

# List firms

> List every client firm registered on your ScripX desk with its live connection state, cursor-paginated.

Every client firm on your desk with its current connection `state`, cursor-paginated (`limit` default 100, max 500). Requires the `firms` scope. This is the read your onboarding dashboard polls.

### Request example

```bash theme={"dark"}
curl "https://api.scripxhq.com/v1/firms" \
  -H "X-ScripX-Key: <YOUR_API_KEY>"
```

### Response example

```json theme={"dark"}
{
  "firms": [
    {
      "iec": "0512345678",
      "name": "Acme Exports Pvt Ltd",
      "role": "exporter",
      "state": "connected",
      "created_at": "2026-07-24T13:20:11+05:30"
    }
  ],
  "count": 1
}
```

The state vocabulary is documented on [Register a firm](/api-reference/firms/create#firm-states).

### Errors

* `401` / `403` / `429`, the standard [auth errors](/authentication#authentication-errors).

**Terms used here:** [IEC](/annexure/terminology#iec), [API key](/annexure/terminology#api-key), [scope](/annexure/terminology#scope), [pagination](/annexure/terminology#cursor-pagination). Full list in the [terminology annexure](/annexure/terminology).

### Next steps

* [Get one firm](/api-reference/firms/get)


## OpenAPI

````yaml GET /v1/firms
openapi: 3.1.0
info:
  title: ScripX Partner API
  version: 1.2.0
  description: >-
    Automate duty-credit-scrip trading: quote, order, positions, market,
    webhooks. Auth: `X-ScripX-Key: scripx_live_…`. Money = integer paise; price
    = bps of face.
  contact:
    name: ScripX API Support
    email: amin@eximfiles.io
    url: https://scripxhq.com
servers:
  - url: https://api.scripxhq.com
    description: >-
      Production and sandbox share one host; a scripx_test_ key selects the
      sandbox.
security:
  - ApiKeyAuth: []
tags:
  - name: Firms
    description: >-
      client-firm lifecycle: register, verify, authorize, credits, update,
      offboard
  - name: Trading
    description: quote, orders, positions, market
  - name: Group
    description: intra-group netting + positions (enterprise/broker)
  - name: Cross
    description: 'broker cross-desk: block deals + intra-group transfers'
  - name: Webhooks
    description: event subscriptions + delivery
  - name: Account
    description: usage + metering
  - name: Keys
    description: self-serve scoped child keys (sub-accounts)
paths:
  /v1/firms:
    get:
      tags:
        - Firms
      summary: List your client firms + connection state
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            maximum: 500
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: opaque offset from a prior response's next_cursor
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirmList'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    FirmList:
      type: object
      properties:
        firms:
          type: array
          items:
            $ref: '#/components/schemas/Firm'
        count:
          type: integer
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: stable machine code
          enum:
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - conflict
            - unprocessable
            - rate_limited
            - internal
        message:
          type: string
        detail:
          type: object
    Firm:
      type: object
      properties:
        iec:
          type: string
        name:
          type: string
        email:
          type: string
        role:
          type: string
          enum:
            - exporter
            - importer
        state:
          type: string
          enum:
            - registered
            - connecting
            - verification_pending
            - connected
            - attention_needed
            - reconnect_needed
        created_at:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-ScripX-Key
      description: >-
        Your API key, e.g. `scripx_live_…`. Bound to one firm; tenant isolation
        is enforced.

````