Heffl Reference Data API
The Reference Data API from Heffl — 7 operation(s) for reference data.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/heffl-com:heffl-com-reference-data-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Heffl Public API (Legacy v1) Reference Data API
version: 1.0.0
description: Legacy Heffl REST API v1. Maintained for existing integrations. For new projects, use API v2 at https://docs.heffl.com/api-v2/introduction.
contact:
name: Heffl Support
url: https://heffl.com/support
email: support@heffl.com
servers:
- url: https://api.heffl.com/api/v1
description: Production API Server
security:
- ApiKeyAuth: []
tags:
- name: Reference Data
paths:
/tags:
get:
operationId: legacy.tags.list
summary: List tags
description: Returns all tags for your team, optionally filtered by type.
tags:
- Reference Data
parameters:
- name: type
in: query
schema:
enum:
- leads
- deals
- clients
- contacts
- projects
- project_tasks
- invoices
- quotations
- schedules
- fs_jobs
- purchase_orders
- vendors
- bills
description: Filter by tag type
style: deepObject
explode: true
allowEmptyValue: true
allowReserved: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: number
description: Tag ID
name:
type: string
description: Tag name
color:
type: string
description: Tag color
type:
type: string
description: Tag type
required:
- id
- name
- color
- type
required:
- items
/pipelines:
get:
operationId: pipelines.list
summary: List deal pipelines
description: Returns all deal pipelines with their stages.
tags:
- Reference Data
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
description: Pipeline public ID
name:
type: string
description: Pipeline name
stages:
type: array
items:
type: object
properties:
id:
type: string
description: Stage public ID
name:
type: string
description: Stage name
position:
type: number
description: Stage position
probability:
type: number
description: Win probability %
required:
- id
- name
- position
- probability
required:
- id
- name
- stages
required:
- items
/pipelines/{id}:
get:
operationId: pipelines.get
summary: Get a pipeline
description: Returns a single deal pipeline with its stages.
tags:
- Reference Data
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Pipeline public ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
stages:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
position:
type: number
probability:
type: number
required:
- id
- name
- position
- probability
required:
- id
- name
- stages
/products:
get:
operationId: legacy.products.list
summary: List products
description: Returns a paginated list of products.
tags:
- Reference Data
parameters:
- name: cursor
in: query
schema:
type: string
description: Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.
allowEmptyValue: true
allowReserved: true
- name: limit
in: query
schema:
type: number
minimum: 1
maximum: 100
default: 20
description: Number of items to return (max 100)
allowEmptyValue: true
allowReserved: true
- name: search
in: query
schema:
type: string
default: ''
description: Search by product name
allowEmptyValue: true
allowReserved: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
description: Product public ID
name:
type: string
description: Product name
price:
type: number
description: Product price
description:
anyOf:
- type: string
- type: 'null'
description: Product description
sku:
anyOf:
- type: string
- type: 'null'
description: SKU code
type:
type: string
description: Product type
isActive:
type: boolean
description: Whether product is active
required:
- id
- name
- price
- type
- isActive
nextCursor:
anyOf:
- type: string
- type: 'null'
description: Cursor to fetch the next page. Null if there are no more results.
hasMore:
type: boolean
description: Whether additional results are available
required:
- items
- hasMore
/products/{id}:
get:
operationId: legacy.products.get
summary: Get a product
description: Returns a single product by public ID.
tags:
- Reference Data
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Product public ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
price:
type: number
description:
anyOf:
- type: string
- type: 'null'
sku:
anyOf:
- type: string
- type: 'null'
type:
type: string
isActive:
type: boolean
required:
- id
- name
- price
- type
- isActive
/leads/stages:
get:
operationId: leadStages.list
summary: List lead stages
description: Returns all lead stages ordered by position.
tags:
- Reference Data
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
description: Stage public ID
label:
type: string
description: Stage label
type:
type: string
description: Stage type
position:
type: number
description: Stage position
required:
- id
- label
- type
- position
required:
- items
/leads/sources:
get:
operationId: leadSources.list
summary: List lead sources
description: Returns all CRM sources (lead sources).
tags:
- Reference Data
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
description: Source public ID
name:
type: string
description: Source name
required:
- id
- name
required:
- items
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: API key for authentication. Get yours at app.heffl.com/settings/developers