Smartcat

Smartcat Custom Fields API

The Custom Fields API from Smartcat — 1 operation(s) for custom fields.

Documentation GitHub OpenAPI

Operations 1

GET /api/integration/v1/custom-fields Retrieves all custom fields defined for the current account #

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/smartcat:smartcat-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

openapi: 3.2.0
info:
  title: Smartcat Custom Fields API
  version: v1
servers:
- url: /
tags:
- name: Custom Fields
paths:
  /api/integration/v1/custom-fields:
    get:
      tags:
      - Custom Fields
      summary: Retrieves all custom fields defined for the current account
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
      operationId: getApiIntegrationV1CustomFields
      x-operation-id-source: derived
components:
  schemas:
    FieldType:
      enum:
      - text
      - select
      type: string
      description: Specifies the data type of a custom field, determining how its value is entered and stored.
      format: int32
    CustomField:
      type: object
      properties:
        internalId:
          type: string
          description: The unique internal identifier of the custom field.
          format: uuid
        entityType:
          $ref: '#/components/schemas/EntityType'
        label:
          type:
          - string
          - 'null'
          description: The human-readable label displayed to users for the custom field.
        id:
          type:
          - string
          - 'null'
          description: The user-defined identifier of the custom field.
        isHidden:
          type: boolean
          description: Indicates whether the custom field is hidden from the user interface.
        fieldType:
          $ref: '#/components/schemas/FieldType'
        usagesCount:
          type: integer
          description: The number of times the custom field is currently being used.
          format: int32
        isVisibleToSuppliers:
          type: boolean
          description: Indicates whether the custom field is visible to the supplier.
        options:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SelectFieldOption'
          description: The collection of pre-filled values available for selection-type fields.
      additionalProperties: false
      description: 'Represents a custom field defined within an account, used to attach

        additional structured data to entities such as projects or assignments.'
    EntityType:
      enum:
      - project
      - freelancer
      - vendor
      - client
      - tM
      - tMUnit
      type: string
      description: Specifies the type of entity that a custom field can be attached to.
      format: int32
    SelectFieldOption:
      type: object
      properties:
        key:
          type: string
          description: The unique identifier of the option.
          format: uuid
        value:
          type:
          - string
          - 'null'
          description: The display value associated with the option.
      additionalProperties: false
      description: 'Represents a single selectable option for a custom field of selection type,

        pairing a unique key with its display value.'