---
title: "Get sale field metadata (V2)"
method: GET
path: "/api/v2/files/sales/fields"
tags: ["V2 Sales"]
---

# Get sale field metadata (V2)

`GET /api/v2/files/sales/fields`

Returns metadata for sale fields based on optional context filters, using V2 managed fields.

### Validation & Requirements
#### Required Parameters
- None

#### Required JSON Body Fields
- None

#### Validations
- Invalid GUID values in `*Guid`/`*Guids` fields return `422 Unprocessable Entity`.
- Invalid date values in `*date*` fields return `422 Unprocessable Entity`.
- Missing required request body returns `422 Unprocessable Entity` with `Missing request body.`.
- Additional business-rule validation may return `422` with details in the `errors` array.

## Query parameters

- `mlsStatus` integer, nullable
- `sourceId` integer, nullable
- `checklistType` string, nullable
- `saleType` string, nullable
- `listingId` integer, nullable
- `saleId` integer, nullable
- `userBeingImpersonated` integer, nullable

## Response `200`

- LinkedResponseOfGetMetadataForSaleFieldsResponse
  - `value` GetMetadataForSaleFieldsResponse
    - `fields` Fields
      - `mlsNumber` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `yearBuilt` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `salePrice` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `saleSize` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `source` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `sourceOther` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `escrowNumber` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `officeLead` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `closingDate` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `actualClosingDate` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `acceptanceDate` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `property` PropertyMetadata
        - `streetNumber` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `direction` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `streetName` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `unit` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `city` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `county` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `state` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
        - `zip` FieldMetadata
          - `isVisible` boolean
          - `isRequired` boolean
          - `label` string, nullable
      - `agent` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `coAgent` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `office` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `checklistType` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `representationType` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `listPrice` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `mlsStatus` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `mlsStatusOther` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `listingExpireDate` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `propertyType` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `propertySubtype` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `renewalOption` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `purchaseOption` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `apn` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
      - `subjectRemovalDate` FieldMetadata
        - `isVisible` boolean
        - `isRequired` boolean
        - `label` string, nullable
  - `warnings` string[], nullable
  - `links` Link[], nullable
    - `href` string, nullable
    - `rel` string, nullable
    - `method` string, nullable

## Other responses

- `404`
- `422`

---

[API](https://skmtc.net/skyslope/apis/skyslope-api.md) · [All operations](https://skmtc.net/skyslope/apis/skyslope-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/skyslope/skyslope-api/revisions/bad0d2db9b7a/schema)