---
title: "Generators search"
method: POST
path: "/generators/action/search"
tags: ["Generators"]
---

# Generators search

`POST /generators/action/search`

## Request

- Base URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1`
- URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1/generators/action/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/generators/action/search/post.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `page` integer
- `size` integer
- `include` string

## Request body

- object
  - `upn` string
  - `name` string
  - `program` string: Ref.Data.REC_PROGRAM
  - `registryAssignedId` string
  - `registryAssignedIds` string[]
  - `hostCountry` string: Ref.Data.COUNTRY
  - `fuelType` string: Ref.Data.REC_FUEL_TYPE
  - `state` string: Ref.Data.STATE_PROVINCE

## Response `200`

Generators search successfully executed

- object
  - `page` integer, required
  - `size` integer, required
  - `totalPages` integer, required
  - `totalElements` integer, required
  - `content` Generator[]
    - `id` integer: The unique XC db identifier for the project or generator.
    - `upn` string: Universal Project Identifier. The unique identifier assigned by Xpansiv Connect to every resource across all registries that have integrated with the Xpansiv Connect platform.
    - `name` string, required: The registry assigned name of the project or generator.
    - `program` string: Ref.Data.REC_PROGRAM
    - `registryAssignedId` string: The registry assigned identifier for the generator.
    - `status` string: The status of the generator in the registry. Ref.Data.GENERATOR_STATUS
    - `siteCode` string: The Site Code of the generator if provided by the registry.
    - `unitName` string: The Unit Name of the generator in the registry.
    - `controlArea` string: The Control Area that the generator is located in.
    - `parentCompanyName` string: The Parent Company Name of the generator if provided by the registry.
    - `powerCompanyName` string: The Power Company Name of the generator if provided by the registry.
    - `powerCompanyCode` string: The Power Company Code of the generator if provided by the registry.
    - `ownerName` string: The Owner Name of the generator if provided by the registry
    - `ownershipType` string: The Ownership Type of the generator if provided by the registry.
    - `countyName` string: The County Name locatio of the generator if provided by the registry.
    - `stateProvince` string: Ref.Data.STATE_PROVINCE
    - `country` string: Ref.Data.COUNTRY
    - `contactInfo` string: Contact Information for the generator if provided by the registry.
    - `registryAcctHolderName` string: The Registry Account Holder name of the generator if provided by the registry.
    - `commencedDt` string, date-time: The Commenced Operation Date of the generator if provided by the registry.
    - `nameplateCapacity` number, double: The Nameplate Capacity of the generator if provided by the registry.
    - `facNoncompetitiveCertData` string
    - `fuelTypes` object[]: Additional information about a generator if it is multi-fuel. Optional property. Use `include` param.
      - `fuelType` FuelType, required
        - `name` string: The fuel type associated with the underlying asset.
        - `type` string: Ref.Data.REC_FUEL_TYPE
        - `fuelSource` string: The registry fuel source associated with the fuel type (registry-dependent).
      - `stateEligibilities` StateEligibility[]
        - `name` string: Name of the state eligibility.
        - `type` string: The type of the state eligibility. Ref.Data.REC_STATE_ELIGIBILITY
        - `stateIdentifier` string: This is the identifier of the eligibility from the registry
      - `voluntaryEligibilities` VoluntaryEligibility[]
        - `name` string: The name of the registry voluntary eligibility.
        - `type` string: The type of the voluntary eligibility. Ref.Data.REC_VOLUNTARY_ELIGIBILITY
        - `effectiveDate` string, date-time: The effective date of the eligibility.
        - `expirationDate` string, date-time: the expiration date of the eligibility.

## Other responses

- `400`: Bad request
- `401`: Not authorized error
- `500`: Internal server error

---

[API](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api.md) - [All operations](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/revisions/01c1f2c4ec1e?raw)