COconversion

List Fields

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.

get/v2/fields

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Query parameters

objectType'CONTACT' | 'COMPANY' | 'OPPORTUNITY' | 'CAMPAIGN' | 'CAMPAIGN_MEMBER' | 'CUSTOM_OBJECT'

Optional object type, case-insensitive. CUSTOM_OBJECT requires customObjectId.

customObjectIdstring uuid

List fields for this custom object. Omit objectType or use CUSTOM_OBJECT.

limitinteger

The maximum number of fields to return per page. Defaults to 50. Values are clamped to the range [1, 100] rather than rejected; values above 100 return 100 results.

cursorstring

The opaque pagination cursor returned as pagination.nextCursor by a previous call. Omit to fetch the first page. An invalid or malformed cursor returns an invalid_cursor error.

Response

Field schemas retrieved successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.