Q2

Q2 Customer API

Endpoints for the customer object

GitHub OpenAPI

Operations 15

POST /customer/archive Archive a customer #
POST /customer/create Create a customer #
POST /customer/createBusiness Create a business customer #
POST /customer/createBusinessApplication Create business application #
GET /customer/generateToken/{customerId} Generate a customer token #
GET /customer/get/{customerId} Get a customer #
GET /customer/getByEmail/{emailAddress} Get a customer via emailAddress #
GET /customer/getByTag/{tag} Get a customer via tag #
GET /customer/list List customers #
POST /customer/note Make a customer note #
GET /customer/notesList/{customerId} List customer notes #
POST /customer/search Search for customers #
POST /customer/setLastContact Set last contact #
POST /customer/update Update a customer #
POST /customer/updateAddress Update a customer address #

Documentation

📖
Documentation
https://docs.helix.q2.com
📖
APIReference
https://docs.helix.q2.com/reference
📖
Quickstart
https://docs.helix.q2.com/reference/quickstart
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/authentication/q2-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/rate-limits/q2-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/openapi/q2-customer-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-customer-object200-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-program-get200-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-card-object200-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-account-object200-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-transaction-object200-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-customer-no-business-fields-array200-response-schema.json

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/errors/q2-error-codes.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/sandbox/q2-sandbox.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/conventions/q2-conventions.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/lifecycle/q2-lifecycle.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/data-model/q2-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/conformance/q2-conformance.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/asyncapi/q2-events-webhooks.yml
🔗
X-MCPServerCandidate
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/mcp/q2-mcp.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/llms/q2-llms.txt

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/q2:q2-customer-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

q2-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Helix Customer API
  version: 3.0.0
  description: Helix Public API (no customer KYC/IDV). **This spec covers all of Helix 3.x and is subject to change at any time.**
servers:
- url: https://sandbox-api.helix.q2.com
  description: Sandbox server
- url: https://api.helix.q2.com
  description: Production server
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/openapi/q2-customer-api-openapi.yml