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

# Retrieve a score set

> Returns a single carbon intensity score set. Poll this endpoint until status is `completed` or `failed`. Requires carbon intensity to be enabled for your account (`feature_carbon_intensity` in `GET /feature_flags`); otherwise returns 403 "Carbon intensity feature is not enabled". Requires the `read:ledger` token scope.



## OpenAPI

````yaml GET /ledgers/{ledger_id}/score_sets/{id}
openapi: 3.1.0
info:
  title: Mangrove - API
  version: 1.1.0
  description: >
    ## Filtering and sorting


    List endpoints that accept `filter` take one query parameter per condition,
    written `filter[field][comparator]=value`, for example
    `filter[name][contains]=North`. The comparators are `eq`, `neq`, `gt`,
    `geq`, `lt`, `leq` and `contains`, and `filter[field]=value` is short for
    `eq`. Conditions combine with AND. `contains` matches part of the value, is
    case-sensitive, and applies only to text fields. An unknown field or
    comparator, a value that doesn't fit the field's type, or a list or object
    as the value returns 400 with a message naming the problem. Each list
    operation names its filterable fields; some take only `eq`, and say so.


    `sort` takes a comma-separated list of fields, for example
    `sort=-created_at,name`. Each field sorts ascending, or descending with a
    `-` prefix. Unknown sort fields are ignored. Sorting by `id` orders by the
    record's internal ID, not its friendly ID. Each list operation names its
    sortable fields.
servers:
  - url: https://app.gomangrove.com/api/v1
security:
  - sec0: []
paths:
  /ledgers/{ledger_id}/score_sets/{id}:
    get:
      summary: Retrieve a score set
      description: >-
        Returns a single carbon intensity score set. Poll this endpoint until
        status is `completed` or `failed`. Requires carbon intensity to be
        enabled for your account (`feature_carbon_intensity` in `GET
        /feature_flags`); otherwise returns 403 "Carbon intensity feature is not
        enabled". Requires the `read:ledger` token scope.
      operationId: get-score-set
      parameters:
        - $ref: '#/components/parameters/LedgerId'
        - name: id
          in: path
          description: The score set's friendly ID (e.g. `scr_aBcD1234eFgH5678`).
          schema:
            type: string
            example: scr_aBcD1234eFgH5678
          required: true
      responses:
        '200':
          description: The score set.
          content:
            application/json:
              example:
                id: scr_aBcD1234eFgH5678
                reporting_period_id: cirp_aBcD1234eFgH5678
                model_id: mod_aBcD1234eFgH5678
                ledger_id: led_aBcD1234eFgH5678
                status: completed
                score: '12.345'
                score_name: Carbon Intensity
                score_unit: kgCO2e/MJ
                reporting_period_label: 2025 Q1 (2025-01-01 - 2025-03-31)
                window_label: 2025 Q1 (2025-01-01 - 2025-03-31)
                start_date: '2025-01-01'
                end_date: '2025-03-31'
                model_label: Carbon Intensity Model
                error_message: null
                has_workbook: true
                ui_url: >-
                  https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_aBcD1234eFgH5678/score-set/scr_aBcD1234eFgH5678
                created_at: '2025-01-15T10:00:00.000Z'
                updated_at: '2025-01-15T10:05:00.000Z'
              schema:
                $ref: '#/components/schemas/ScoreSetDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Carbon intensity is not enabled for your account, or the token lacks
            the `read:ledger` scope.
          content:
            application/json:
              example:
                errors:
                  - message: Carbon intensity feature is not enabled
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The ledger or score set does not exist in the account, or the ledger
            is not a carbon intensity ledger.
          content:
            application/json:
              examples:
                Unknown ledger:
                  value:
                    errors:
                      - message: Record not found
                Not a carbon intensity ledger:
                  value:
                    errors:
                      - message: Carbon intensity ledger configuration not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    LedgerId:
      name: ledger_id
      in: path
      required: true
      description: The ledger's friendly ID (e.g. `led_aBcD1234eFgH5678`).
      schema:
        type: string
  schemas:
    ScoreSetDetail:
      allOf:
        - $ref: '#/components/schemas/ScoreSet'
        - type: object
          properties:
            has_workbook:
              type: boolean
              description: >-
                Whether the score set's run produced a downloadable Excel
                workbook or openLCA pathway file.
            ui_url:
              type: string
              format: uri
              description: >-
                Link that opens this score set in the Mangrove app, built from
                the project, ledger and score set friendly IDs.
              example: >-
                https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_aBcD1234eFgH5678/score-set/scr_aBcD1234eFgH5678
    ErrorResponse:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
                description: Human-readable error message
              field:
                type: string
                description: Attribute the error applies to (validation errors only)
              code:
                type: string
                description: Machine-readable error code (validation errors only)
              blocking:
                type: array
                description: >-
                  Bounded preview of the records blocking a destroy
                  (blocked-destroy errors only)
                items:
                  $ref: '#/components/schemas/DeletionBlockingRecord'
              blocking_count:
                type: integer
                description: >-
                  Total count of records blocking a destroy (blocked-destroy
                  errors only)
              config_key:
                type: string
                description: >-
                  The data feed source config setting to fix, when the error is
                  on `config` (data feed source validation errors only)
              count:
                type: number
                description: >-
                  The limit or comparison value the failed validation checked
                  against, e.g. a maximum length or a numeric bound (validation
                  errors only, when the validation has one)
              value:
                description: >-
                  The rejected value, e.g. on an inclusion or uniqueness failure
                  (validation errors only, when the validation reports one)
    ScoreSet:
      type: object
      properties:
        id:
          type: string
          example: scr_aBcD1234eFgH5678
        reporting_period_id:
          type:
            - string
            - 'null'
          example: cirp_aBcD1234eFgH5678
        model_id:
          type:
            - string
            - 'null'
          example: mod_aBcD1234eFgH5678
        ledger_id:
          type:
            - string
            - 'null'
          example: led_aBcD1234eFgH5678
        status:
          type: string
          enum:
            - initialized
            - running
            - completed
            - failed
        score:
          type:
            - string
            - 'null'
          description: >-
            The score as a decimal string (e.g. `"12.345"`; a whole number
            renders as `"12.0"`). Null until the calculation completes.
        score_name:
          type:
            - string
            - 'null'
        score_unit:
          type:
            - string
            - 'null'
        reporting_period_label:
          type:
            - string
            - 'null'
          description: >-
            The reporting period's label with its dates. Null for an ad-hoc
            score set; use `window_label`, which is always populated.
        window_label:
          type: string
          description: >-
            Human-readable label for the scored window, whether it came from a
            reporting period or an ad-hoc start/end range.
        start_date:
          type:
            - string
            - 'null'
          format: date
        end_date:
          type:
            - string
            - 'null'
          format: date
        model_label:
          type:
            - string
            - 'null'
        error_message:
          type:
            - string
            - 'null'
          description: >-
            Failure cause when status is failed — the model run's per-node error
            summary when it recorded any, otherwise the calculation task's
            message. Null otherwise.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    DeletionBlockingRecord:
      type: object
      required:
        - type
      properties:
        type:
          type: string
        friendly_id:
          type: string
        name:
          type:
            - string
            - 'null'
          description: >-
            Display label, and the only identifier for records that have no
            friendly_id
  responses:
    Unauthorized:
      description: >-
        The API token is missing, invalid or expired. The body is empty, except
        for an expired token, which returns the error below.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: API token has expired
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: ''

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.