Copper Financial

Copper Financial Custom Fields API

Custom field definitions and operations

GitHub OpenAPI

Operations 2

GET /custom_activity_types List all custom activity types #
GET /custom_field_definitions List custom field definitions #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/copper-financial/openapi/copper-financial-custom-fields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/copper-financial/json-schema/copper-financial-person-schema.json
📊
JSONSchema
https://artifacts.apis.io/copper-financial/json-schema/copper-financial-lead-schema.json
📊
JSONSchema
https://artifacts.apis.io/copper-financial/json-schema/copper-financial-opportunity-schema.json
📊
JSONSchema
https://artifacts.apis.io/copper-financial/json-schema/copper-financial-company-schema.json
📊
JSONSchema
https://artifacts.apis.io/copper-financial/json-schema/copper-financial-task-schema.json
📊
JSONSchema
https://artifacts.apis.io/copper-financial/json-schema/copper-financial-activity-schema.json

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/copper-financial:copper-financial-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

copper-financial-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Copper CRM Read-Only Custom Fields API
  description: Read-only operations for Copper CRM API - optimized for ChatGPT integration
  version: 1.0.0
  contact:
    name: Copper Developer Support
    url: https://developer.copper.com/
    email: support@copper.com
servers:
- url: https://api.copper.com/developer_api/v1
  description: Copper API Production Server
security:
- bearerAuth: []
tags:
- name: Custom Fields
  description: Custom field definitions and operations
paths:
  /custom_activity_types:
    get:
      tags:
      - Custom Fields
      summary: List all custom activity types
      description: Retrieve a list of all custom activity types in the account
      operationId: listCustomActivityTypes
      responses:
        '200':
          description: Custom activity types retrieved successfully
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomActivityType'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /custom_field_definitions:
    get:
      tags:
      - Custom Fields
      summary: List custom field definitions
      description: Retrieve a list of all custom field definitions in the account
      operationId: listCustomFieldDefinitions
      responses:
        '200':
          description: Custom field definitions retrieved successfully
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFieldDefinition'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  headers:
    Retry-After:
      description: The number of seconds to wait before making a new request after hitting the rate limit
      schema:
        type: integer
        example: 60
    X-RateLimit-Reset:
      description: The time at which the current rate limit window resets, in UTC epoch seconds
      schema:
        type: integer
        example: 1640995200
    X-RateLimit-Remaining:
      description: The number of requests remaining in the current time window
      schema:
        type: integer
        example: 179
    X-RateLimit-Limit:
      description: The maximum number of requests allowed in the current time window
      schema:
        type: integer
        example: 180
  responses:
    BadRequest:
      description: Bad Request - The request was invalid or cannot be served
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error - An unexpected error occurred
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized - Authentication credentials were missing or incorrect
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    CustomActivityType:
      type: object
      description: Custom activity types allow you to define custom activities beyond the default Copper activity types
      properties:
        id:
          type: integer
          description: Unique identifier for the custom activity type
          example: 12345
        name:
          type: string
          description: Name of the custom activity type
          example: Product Demo
        icon_type:
          type: string
          nullable: true
          description: Icon type for the custom activity
          example: calendar
        is_disabled:
          type: boolean
          description: Whether the custom activity type is disabled
          example: false
        is_interaction:
          type: boolean
          description: Whether this activity type counts as an interaction
          example: true
        count_as_interaction:
          type: boolean
          description: Legacy field - same as is_interaction
          example: true
      required:
      - id
      - name
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
              example: RATE_LIMIT_EXCEEDED
            message:
              type: string
              description: Human-readable error message
              example: You have exceeded your rate limit of 180 requests per minute
            details:
              type: object
              description: Additional error details
              additionalProperties: true
          required:
          - code
          - message
      required:
      - error
    CustomFieldDefinition:
      type: object
      description: 'Custom fields are available on all main objects: Leads, People, Companies, Opportunities, Projects, and Tasks. Custom fields can have various data types including text, dropdown, date, currency, percentage, etc.'
      properties:
        id:
          type: integer
          description: Unique identifier for the custom field definition
          example: 100764
        name:
          type: string
          description: Name of the custom field
          example: Multi-Select Dropdown
        canonical_name:
          type: string
          nullable: true
          description: Canonical name for the custom field
          example: null
        data_type:
          type: string
          description: Data type of the custom field
          enum:
          - String
          - Text
          - Dropdown
          - MultiSelect
          - Date
          - Checkbox
          - Float
          - URL
          - Percentage
          - Currency
          - Connect
          example: MultiSelect
        available_on:
          type: array
          items:
            type: string
            enum:
            - lead
            - person
            - company
            - opportunity
            - project
            - task
          description: Array of entity types this field is available on
          example:
          - lead
          - person
          - opportunity
          - company
        options:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                description: The option ID
              name:
                type: string
                description: The option name/value
              rank:
                type: integer
                description: The display order of the option
          description: Available options for Dropdown and MultiSelect field types
        currency:
          type: string
          nullable: true
          description: Currency code for Currency field types
          example: USD
      required:
      - id
      - name
      - data_type
      - available_on
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Copper API key for authentication. Get your API key from your Copper account settings.
x-rate-limit:
  description: Copper API rate limiting information
  general:
    limit: 180
    period: minute
    description: Maximum of 180 requests per minute for general API calls
  bulk:
    limit: 3
    period: second
    description: Maximum of 3 requests per second for bulk operations