---
title: "Projects search"
method: POST
path: "/projects/action/search"
tags: ["Projects"]
---

# Projects search

`POST /projects/action/search`

## Request

- Base URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1`
- URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1/projects/action/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/projects/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
  - `country` string: Ref.Data.COUNTRY
  - `status` string: Ref.Data.PROJECT_STATUS
  - `program` string: Ref.Data.CARBON_PROGRAM
  - `registryAssignedId` string
  - `certification` string: Certification code. Ref.Data.CARBON_CERTIFICATION

## Response `200`

Projects search successfully executed

- object
  - `page` integer, required
  - `size` integer, required
  - `totalPages` integer, required
  - `totalElements` integer, required
  - `content` Project[]
    - `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.
    - `programs` object[], required
      - `program` string, required: Ref.Data.CARBON_PROGRAM
      - `programName` string: Registry name.
      - `registryAssignedId` string, required: ID assigned by the registry.
      - `registryAccountHolderName` string: Name of the registry account holder.
      - `status` string, required: The registry status of the project. Ref.Data.PROJECT_REGISTRY_STATUS
      - `creditType` string, required: The type of the credit. Ref.Data.CARBON_CREDIT_TYPE
      - `projectType` string, required: The project type. Ref.Data.CARBON_PROJECT_TYPE
      - `baselineMethodologies` RefBaselineMethodology[]
      - `creditingPeriodBegin` string, date-time: Begin date for credit reporting.
      - `creditingPeriodEnd` string, date-time: End date for credit reporting.
    - `description` string: The full description from the registry.
    - `status` string: Ref.Data.PROJECT_STATUS
    - `country` string: Ref.Data.COUNTRY
    - `stateProvince` string: State or Province
    - `city` string: City.
    - `location` Location
      - `latitude` number, double: Latitude.
      - `longitude` number, double: Longitude.
    - `annualAverageOffsetQty` integer: Annual average offset quantity.
    - `projectCertifications` ProjectCertification[]: Optional property. Use `include` param.
      - `code` string: Certification code. Ref.Data.CARBON_CERTIFICATION
      - `projectCertificationDateRanges` object[]
        - `certificationStart` string, date-time: The project certification start date.
        - `certificationEnd` string, date-time: The project certification end date.
    - `issuanceCertifications` IssuanceCertification[]: Optional property. Use `include` param.
      - `code` string: Certification code. Ref.Data.CARBON_CERTIFICATION
      - `vintageYears` integer[]: Vintage years.

## 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)