---
title: "List Fields"
method: GET
path: "/v2/fields"
---

# List Fields

`GET /v2/fields`

## Request

- Base URL: `https://pub-api.conversion.ai/api`
- URL: `https://pub-api.conversion.ai/api/v2/fields`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

List field definitions, including IDs, keys, data types, and relationship metadata. With no filters, returns standard-object fields. Pass `customObjectId` to list fields for one custom object. Requires field view permission and view access to that custom object.

Pass `pagination.nextCursor` as `cursor` for the next page. A null cursor means there are no more results.

## Query parameters

- `objectType` 'CONTACT' | 'COMPANY' | 'OPPORTUNITY' | 'CAMPAIGN' | 'CAMPAIGN_MEMBER' | 'CUSTOM_OBJECT'
- `customObjectId` string, uuid
- `limit` integer
- `cursor` string

## Response `200`

Field schemas retrieved successfully.

- object
  - `data` object
    - `fields` FieldSchema[], required: The current page of field schemas.
      - `key` string, required: Key used in record field maps.
      - `label` string, required
      - `objectType` 'CONTACT' | 'COMPANY' | 'OPPORTUNITY' | 'CAMPAIGN' | 'CAMPAIGN_MEMBER' | 'CUSTOM_OBJECT', required
      - `customObjectId` string, uuid: Present for custom-object fields.
      - `dataType` 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'PICKLIST' | 'RELATIONSHIP', required
      - `readOnly` boolean, required: Whether this field is unavailable for writes through the custom-object batch endpoint.
      - `relationshipTargets` RelationshipFieldReference[]: Fields on the other side of this relationship, identified by key and object. For a reverse field, this points to its writable source field.
        - `key` string, required
        - `objectType` 'CONTACT' | 'COMPANY' | 'OPPORTUNITY' | 'CAMPAIGN' | 'CAMPAIGN_MEMBER' | 'CUSTOM_OBJECT', required
        - `customObjectId` string, uuid
  - `pagination` object
    - `nextCursor` string, nullable, required: Opaque cursor for the next page, or `null` when there are no more results. This is the single source of truth for whether more results exist.

## Other responses

- `400`: The request was malformed or contained invalid data.
- `401`: Authentication failed.
- `403`: The API key lacks permission.
- `404`: Custom object not found in this workspace.
- `500`: An unexpected server error occurred.

---

[API](https://skmtc.dev/conversion/apis/conversion-api.md) - [All operations](https://skmtc.dev/conversion/apis/conversion-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conversion/apis/conversion-api/revisions/8422f815402a?raw)