---
title: "List introducing brokers with sales users and companies"
method: GET
path: "/api-regulated/v1/introducing-brokers/with-sales-users-and-companies"
tags: ["IntroducingBroker"]
---

# List introducing brokers with sales users and companies

`GET /api-regulated/v1/introducing-brokers/with-sales-users-and-companies`

## Request

- Base URL: `https://api.currencyguard.com`
- URL: `https://api.currencyguard.com/api-regulated/v1/introducing-brokers/with-sales-users-and-companies`
- Auth: HTTP bearer

Returns all introducing brokers for the authenticated user's regulated entity, each with their associated sales users and companies in a single response.

## Response `200`

Retrieved successfully

- IntroducingBrokerWithSalesUsersAndCompaniesDTO[]
  - `introducingBroker` IntroducingBrokerDTO: Schema for representing a IntroducingBroker
    - `id` string, uuid: The ID for this introducing broker.
    - `regulatedEntityId` string, uuid: The ID of the regulated entity this introducing broker belongs to.
    - `status` 'PENDING' | 'ENABLED' | 'DISABLED' | 'DELETED': The status of this introducing broker.
    - `piiData` IntroducingBrokerDTOPiiData: **Extensible JSONB field** - The PII data for this introducing broker as JSONB (includes name, contact info, auth email domains). This field accepts any valid JSON structure and can be extended with additional properties as needed. Note: While the structure is extensible, known fields shown in the example are subject to application validation.
    - `oauthPoolId` string, uuid: The OAuth pool this broker's own staff authenticate against.
    - `customerOauthPoolId` string, uuid: The OAuth pool the customers of this broker's companies authenticate against.
    - `perimeterId` string, uuid: The tenant perimeter whose KMS key encrypts this record's PII.
    - `eventSequence` integer: Event sequence number for event sourcing.
    - `versionNumber` integer: The strictly monotonically increasing version number for this record.
    - `updatedBy` string: The username of the person or entity that updated this record.
    - `updatedAt` string: The timestamp of the last update in UTC.
    - `createdAt` string: The timestamp of creation in UTC.
  - `salesUsers` SalesUserDTO[]: Sales users belonging to this introducing broker
    - `id` string, uuid: The ID for this sales user (shared with cgo_user).
    - `regulatedEntityId` string, uuid: The ID of the regulated entity this sales user belongs to.
    - `introducingBrokerId` string, uuid: The ID of the introducing broker this sales user belongs to.
    - `isActive` boolean: Whether the sales user is currently active.
    - `eventSequence` integer: Event sequence number for event sourcing.
    - `versionNumber` integer: The strictly monotonically increasing version number for this record.
    - `updatedBy` string: The username of the person or entity that updated this record.
    - `updatedAt` string: The timestamp of the last update in UTC.
    - `createdAt` string: The timestamp of creation in UTC.
  - `companies` CompanyDTO[]: Companies belonging to this introducing broker
    - `id` string, uuid: The ID for this company.
    - `regulatedEntityId` string, uuid: The ID of the regulated entity this company belongs to.
    - `introducingBrokerId` string, uuid: The ID of the introducing broker this company belongs to.
    - `status` 'PENDING' | 'ENABLED' | 'DISABLED' | 'DELETED': The status of this company.
    - `piiData` CompanyDTOPiiData: **Extensible JSONB field** - The PII data for this company as encrypted JSON. This field accepts any valid JSON structure and can be extended with additional properties as needed. Note: While the structure is extensible, known fields shown in the example are subject to application validation.
    - `oauthPoolId` string, uuid: The OAuth pool this company's users authenticate against, shared with its broker.
    - `perimeterId` string, uuid: The tenant perimeter whose KMS key encrypts this record's PII.
    - `baseCurrency` string: The company's functional/home currency (ISO 4217). Defaults the guard currency for this company's guards.
    - `eventSequence` integer: Event sequence number for event sourcing.
    - `versionNumber` integer: The strictly monotonically increasing version number for this record.
    - `updatedBy` string: The username of the person or entity that updated this record.
    - `updatedAt` string: The timestamp of the last update in UTC.
    - `createdAt` string: The timestamp of creation in UTC.

## Other responses

- `401`: Not authenticated — [`security/authentication-failed`](/problems/security/authentication-failed/)
- `403`: Not authorized - requires REGULATED role — [`security/insufficient-permissions`](/problems/security/insufficient-permissions/)
- `500`: Internal server error — [`server/internal-error`](/problems/server/internal-error/)

---

[API](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external.md) · [All operations](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/llms.txt) · [OpenAPI document](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/revisions/a1f3f854190d?raw)