The custom_field API from Hubflo — 2 operation(s) for custom_field.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/hubflo:hubflo-custom-field-api"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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Hubflo Custom Field API
version: v2
description: The Hubflo API allows you to write and read data from the Hubflo application.
servers:
- url: https://app.hubflo.com
description: The production API server
- url: https://staging.hubflo.com
description: The staging API server
- url: http://localhost:3000
description: The local API server
tags:
- name: Custom Field
paths:
/api/v2/custom-fields:
get:
summary: Retrieves the custom fields
security:
- bearer_auth: []
description: Returns the custom fields
tags:
- Custom Field
parameters:
- name: page
in: query
required: false
description: Page number
example: 1
schema:
type: number
- name: per_page
in: query
required: false
description: Number of items per page (max 100)
example: 10
schema:
type: number
- name: resource_type
in: query
required: false
description: Filter by resource type (project, task, contact or company)
schema:
type: string
responses:
'200':
description: Custom fields retrieved
headers:
Content-Type:
schema:
type: string
description: application/json; charset=utf-8
X-Organization-ID:
schema:
type: string
description: The organization ID
X-Rate-Limit:
schema:
type: integer
description: Max allowed requests in the current period
X-Remaining-Requests:
schema:
type: integer
description: Remaining requests in the current period
X-Page:
schema:
type: integer
description: Current page number
X-Per-Page:
schema:
type: integer
description: Number of items per page
X-Total-Pages:
schema:
type: integer
description: Total number of pages
X-Next-Page:
schema:
type:
- integer
- 'null'
description: Next page number
X-Prev-Page:
schema:
type:
- integer
- 'null'
description: Previous page number
X-Total-Count:
schema:
type: integer
description: Total number of items
content:
application/json:
examples:
example:
value:
- id: 1376c7d8-c4a0-4e61-b057-598d81873a3b
name: Hailey17
serialization_name: custom_field_hailey17
description: null
field_type: string
required: false
created_at: '2026-07-17T13:09:12Z'
type: contact
options: []
- id: 53adc30d-4d95-400e-aafe-a3b3a39d3785
name: Elouise16
serialization_name: custom_field_elouise16
description: null
field_type: string
required: false
created_at: '2026-07-17T13:09:12Z'
type: contact
options: []
'401':
description: 'unauthorized: the Authorization header is missing or invalid'
content:
application/json:
examples:
example:
value:
status: 401
title: Unauthorized
message: Invalid API token
schema:
$ref: '#/components/schemas/error_unauthorized'
'429':
description: 'too many requests: the user has reached the rate limit'
content:
application/json:
examples:
example:
value:
status: 429
title: Too Many Requests
message: Rate limit reached. Please wait for a couple of minutes.
schema:
$ref: '#/components/schemas/error_too_many_requests'
operationId: getApiV2CustomFields
x-operation-id-source: derived
post:
summary: Creates a custom field
security:
- bearer_auth: []
description: Returns the created custom field
tags:
- Custom Field
parameters: []
responses:
'201':
description: Custom field created
headers:
Content-Type:
schema:
type: string
description: application/json; charset=utf-8
X-Organization-ID:
schema:
type: string
description: The organization ID
X-Rate-Limit:
schema:
type: integer
description: Max allowed requests in the current period
X-Remaining-Requests:
schema:
type: integer
description: Remaining requests in the current period
content:
application/json:
examples:
example:
value:
id: 7a1483cb-4302-42c4-bb6e-18c460a1fbbe
name: Birthday
serialization_name: custom_field_birthday
description: The contact's birthday
field_type: date
required: false
created_at: '2026-07-17T13:09:12Z'
type: contact
options: []
'401':
description: 'unauthorized: the Authorization header is missing or invalid'
content:
application/json:
examples:
example:
value:
status: 401
title: Unauthorized
message: Invalid API token
schema:
$ref: '#/components/schemas/error_unauthorized'
'422':
description: 'unprocessable content: the resource can''t be created'
content:
application/json:
examples:
example:
value:
status: 422
title: Unprocessable Content
message: 'Validation failed: Name must be filled in, Internal name must be filled in, Associated Model must be filled in'
schema:
$ref: '#/components/schemas/error_unprocessable_content'
'429':
description: 'too many requests: the user has reached the rate limit'
content:
application/json:
examples:
example:
value:
status: 429
title: Too Many Requests
message: Rate limit reached. Please wait for a couple of minutes.
schema:
$ref: '#/components/schemas/error_too_many_requests'
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Birthday
description:
type: string
example: The contact's birthday
type:
type: string
enum:
- contact
- company
- project
- task
example: contact
field_type:
type: string
enum:
- string
- integer
- decimal
- date
- list
- boolean
example: string
required:
type: boolean
example: false
options:
type: array
items:
type: string
example:
- Bronze
- Silver
- Gold
description: Required when field_type is `list`. Each entry becomes a CustomFieldOption.
required:
- name
- type
- field_type
required: true
description: Custom field attributes
operationId: postApiV2CustomFields
x-operation-id-source: derived
/api/v2/custom-fields/{id}:
parameters:
- name: id
in: path
required: true
description: Custom field ID
schema:
type: string
get:
summary: Retrieves a custom field
security:
- bearer_auth: []
description: Returns a custom field
tags:
- Custom Field
responses:
'200':
description: Custom field retrieved
headers:
Content-Type:
schema:
type: string
description: application/json; charset=utf-8
X-Organization-ID:
schema:
type: string
description: The organization ID
X-Rate-Limit:
schema:
type: integer
description: Max allowed requests in the current period
X-Remaining-Requests:
schema:
type: integer
description: Remaining requests in the current period
content:
application/json:
examples:
example:
value:
id: 914588ac-991f-4227-96ed-820897fc5c12
name: Theodora34
serialization_name: custom_field_theodora34
description: null
field_type: string
required: false
created_at: '2026-07-17T13:09:13Z'
type: contact
options: []
'401':
description: 'unauthorized: the Authorization header is missing or invalid'
content:
application/json:
examples:
example:
value:
status: 401
title: Unauthorized
message: Invalid API token
schema:
$ref: '#/components/schemas/error_unauthorized'
'404':
description: 'not found: the resource is not found'
content:
application/json:
examples:
example:
value:
status: 404
title: Not Found
message: Resource not found
schema:
$ref: '#/components/schemas/error_not_found'
'429':
description: 'too many requests: the user has reached the rate limit'
content:
application/json:
examples:
example:
value:
status: 429
title: Too Many Requests
message: Rate limit reached. Please wait for a couple of minutes.
schema:
$ref: '#/components/schemas/error_too_many_requests'
operationId: getApiV2CustomFieldsById
x-operation-id-source: derived
patch:
summary: Updates a custom field
security:
- bearer_auth: []
description: Returns the updated custom field
tags:
- Custom Field
parameters: []
responses:
'200':
description: Custom field updated
headers:
Content-Type:
schema:
type: string
description: application/json; charset=utf-8
X-Organization-ID:
schema:
type: string
description: The organization ID
X-Rate-Limit:
schema:
type: integer
description: Max allowed requests in the current period
X-Remaining-Requests:
schema:
type: integer
description: Remaining requests in the current period
content:
application/json:
examples:
example:
value:
id: 32aff99f-2fd0-43d3-a67f-46717084d0ce
name: Updated name
serialization_name: custom_field_pearle40
description: Updated description
field_type: string
required: true
created_at: '2026-07-17T13:09:13Z'
type: contact
options: []
'401':
description: 'unauthorized: the Authorization header is missing or invalid'
content:
application/json:
examples:
example:
value:
status: 401
title: Unauthorized
message: Invalid API token
schema:
$ref: '#/components/schemas/error_unauthorized'
'404':
description: 'not found: the resource is not found'
content:
application/json:
examples:
example:
value:
status: 404
title: Not Found
message: Resource not found
schema:
$ref: '#/components/schemas/error_not_found'
'429':
description: 'too many requests: the user has reached the rate limit'
content:
application/json:
examples:
example:
value:
status: 429
title: Too Many Requests
message: Rate limit reached. Please wait for a couple of minutes.
schema:
$ref: '#/components/schemas/error_too_many_requests'
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Birthday
description:
type: string
example: The contact's birthday
type:
type: string
enum:
- contact
- company
- project
- task
example: contact
field_type:
type: string
enum:
- string
- integer
- decimal
- date
- list
- boolean
example: string
required:
type: boolean
example: false
options:
type: array
items:
type: string
example:
- Bronze
- Silver
- Gold
description: Replaces the current options entirely. Required when field_type is `list`.
required: true
description: Custom field attributes
operationId: patchApiV2CustomFieldsById
x-operation-id-source: derived
delete:
summary: Deletes a custom field
security:
- bearer_auth: []
tags:
- Custom Field
responses:
'204':
description: Custom field deleted
headers:
X-Organization-ID:
schema:
type: string
description: The organization ID
X-Rate-Limit:
schema:
type: integer
description: Max allowed requests in the current period
X-Remaining-Requests:
schema:
type: integer
description: Remaining requests in the current period
content:
application/json:
examples:
example:
value: ''
'401':
description: 'unauthorized: the Authorization header is missing or invalid'
content:
application/json:
examples:
example:
value:
status: 401
title: Unauthorized
message: Invalid API token
schema:
$ref: '#/components/schemas/error_unauthorized'
'404':
description: 'not found: the resource is not found'
content:
application/json:
examples:
example:
value:
status: 404
title: Not Found
message: Resource not found
schema:
$ref: '#/components/schemas/error_not_found'
'429':
description: 'too many requests: the user has reached the rate limit'
content:
application/json:
examples:
example:
value:
status: 429
title: Too Many Requests
message: Rate limit reached. Please wait for a couple of minutes.
schema:
$ref: '#/components/schemas/error_too_many_requests'
operationId: deleteApiV2CustomFieldsById
x-operation-id-source: derived
components:
schemas:
error_unprocessable_content:
description: A response describing a validation error
type: object
properties:
status:
type: integer
example: 422
title:
type: string
example: Unprocessable Content
message:
type: string
example: 'Validation failed: Title can''t be blank'
required:
- status
- title
- message
error_not_found:
description: A response describing a not found error
type: object
properties:
status:
type: integer
example: 404
title:
type: string
example: Not Found
message:
type: string
example: Resource not found
required:
- status
- title
- message
error_too_many_requests:
description: A response describing a rate limit error
type: object
properties:
status:
type: integer
example: 429
title:
type: string
example: Too Many Requests
message:
type: string
example: Rate limit reached. Please wait for a couple of minutes.
required:
- status
- title
- message
error_unauthorized:
description: A response describing an authentication error
type: object
properties:
status:
type: integer
example: 401
title:
type: string
example: Unauthorized
message:
type: string
example: API token not found
required:
- status
- title
- message
securitySchemes:
bearer_auth:
type: http
scheme: bearer
x-readme:
explorer-enabled: true
proxy-enabled: true