Salesflare

Salesflare Custom Fields API

The Custom Fields API from Salesflare — 4 operation(s) for custom fields.

GitHub OpenAPI

Operations 7

GET /customfields/types List custom field types #
GET /customfields/{itemClass} List custom fields of a type #
POST /customfields/{itemClass} Create a custom field of a type #
GET /customfields/{itemClass}/{id} Get custom field details #
PUT /customfields/{itemClass}/{id} Update a custom field #
DELETE /customfields/{itemClass}/{id} Delete a custom field #
GET /customfields/{itemClass}/{customFieldApiField}/options List a custom field's options #

Documentation

📖
Documentation
https://api.salesflare.com/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesflare/refs/heads/main/openapi/salesflare-custom-fields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesflare/refs/heads/main/json-schema/salesflare-schemas.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/salesflare/refs/heads/main/overlays/salesflare-custom-fields-overlay.yaml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/salesflare/refs/heads/main/json-ld/salesflare-context.jsonld
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/salesflare/refs/heads/main/vocabulary/salesflare-vocabulary.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/salesflare-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

salesflare-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesflare Custom Fields API
  version: 1.0.0
  description: '# Introduction


    ## Getting Started


    The Salesflare API allows you to access and build your own applications or integrations that interact with Salesflare.'
  contact:
    email: support@salesflare.com
  x-logo:
    url: https://lib.salesflare.com/api_docs/sf-logo-inverted.svg
    backgroundColor: '#0f1528'
    altText: Salesflare logo
servers:
- url: https://api.salesflare.com
tags:
- name: Custom Fields
paths:
  /customfields/types:
    get:
      summary: List custom field types
      operationId: getCustomfieldsTypes
      tags:
      - Custom Fields
      responses:
        default:
          description: Successful
          content:
            '*/*':
              schema:
                type: string
  /customfields/{itemClass}:
    get:
      summary: List custom fields of a type
      operationId: getCustomfieldsItemclass
      parameters:
      - name: itemClass
        in: path
        required: true
        schema:
          type: string
          enum:
          - accounts
          - contacts
          - opportunities
      - name: includeDisabled
        in: query
        schema:
          type: boolean
      - name: pipeline
        in: query
        schema:
          type: number
      - name: name
        in: query
        schema:
          type: string
      tags:
      - Custom Fields
      responses:
        default:
          description: Successful
          content:
            '*/*':
              schema:
                type: string
    post:
      summary: Create a custom field of a type
      operationId: postCustomfieldsItemclass
      parameters:
      - name: itemClass
        in: path
        required: true
        schema:
          type: string
          enum:
          - accounts
          - contacts
          - opportunities
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: number
                name:
                  type: string
                enabled:
                  type: boolean
                archived:
                  type: boolean
                required:
                  type: boolean
                pipeline:
                  type: number
                predefined_customfield:
                  type: number
                users_can_add_options:
                  type: boolean
                options:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: number
                      order:
                        type: number
                      archived:
                        type: boolean
                      name:
                        type: string
                    required:
                    - name
                order_alphabetically:
                  type: boolean
                  default: false
                min_number:
                  type: number
                max_number:
                  type: number
                min_date:
                  type: string
                  format: date-time
                max_date:
                  type: string
                  format: date-time
                default_boolean_value:
                  type: boolean
      tags:
      - Custom Fields
      responses:
        '200':
          description: Successful
          content:
            '*/*':
              schema:
                type: object
                properties:
                  id:
                    type: number
  /customfields/{itemClass}/{id}:
    get:
      summary: Get custom field details
      operationId: getCustomfieldsItemclassId
      parameters:
      - name: itemClass
        in: path
        required: true
        schema:
          type: string
          enum:
          - accounts
          - contacts
          - opportunities
      - name: id
        in: path
        required: true
        schema:
          type: number
      tags:
      - Custom Fields
      responses:
        default:
          description: Successful
          content:
            '*/*':
              schema:
                type: string
    put:
      summary: Update a custom field
      operationId: putCustomfieldsItemclassId
      parameters:
      - name: itemClass
        in: path
        required: true
        schema:
          type: string
          enum:
          - accounts
          - contacts
          - opportunities
      - name: id
        in: path
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: number
                type:
                  type: number
                  description: Deprecated. Do not use this field.
                name:
                  type: string
                enabled:
                  type: boolean
                archived:
                  type: boolean
                required:
                  type: boolean
                pipeline:
                  type: number
                pipelineName:
                  type: string
                order:
                  type: number
                predefined_customfield:
                  type: number
                users_can_add_options:
                  type: boolean
                options:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: number
                      order:
                        type: number
                      archived:
                        type: boolean
                      name:
                        type: string
                    required:
                    - name
                order_alphabetically:
                  type: boolean
                min_number:
                  type: number
                max_number:
                  type: number
                min_date:
                  type: string
                  format: date-time
                max_date:
                  type: string
                  format: date-time
              required:
              - id
      tags:
      - Custom Fields
      responses:
        default:
          description: Successful
          content:
            '*/*':
              schema:
                type: string
    delete:
      summary: Delete a custom field
      operationId: deleteCustomfieldsItemclassId
      parameters:
      - name: itemClass
        in: path
        required: true
        schema:
          type: string
          enum:
          - accounts
          - contacts
          - opportunities
      - name: id
        in: path
        required: true
        schema:
          type: number
      tags:
      - Custom Fields
      responses:
        default:
          description: Successful
          content:
            '*/*':
              schema:
                type: string
  /customfields/{itemClass}/{customFieldApiField}/options:
    get:
      summary: List a custom field's options
      operationId: getCustomfieldsItemclassCustomfieldapifieldOptions
      parameters:
      - name: itemClass
        in: path
        required: true
        schema:
          type: string
          enum:
          - accounts
          - contacts
          - opportunities
      - name: customFieldApiField
        in: path
        required: true
        schema:
          type: string
      - name: searchString
        in: query
        schema:
          type: string
      tags:
      - Custom Fields
      responses:
        default:
          description: Successful
          content:
            '*/*':
              schema:
                type: string
x-tagGroups:
- name: General
  tags:
  - Tasks
  - Accounts
  - Contacts
  - Opportunities
  - Workflows
  - Insights
- name: Interactions
  tags:
  - Calls
  - Meetings
  - Internal Notes
- name: User Management
  tags:
  - Users
  - Groups
- name: Configuration
  tags:
  - Regional Settings
  - Pipelines
  - Custom Fields
  - Email Data Sources
  - Tags
  - Filter Fields
  - Persons