hyreflow-ai CRM API

The Crm API from hyreflow-ai — 10 operation(s) for crm.

Operations 10

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/hyreflow-ai:hyreflow-ai-crm-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

openapi: 3.2.0
info:
  title: hyreflow engine (local) CRM API
  version: 0.1.0
tags:
- name: CRM
paths:
  /api/v2/crm/act/{module}/{name}:
    post:
      summary: Crm Act
      operationId: crm_act_api_v2_crm_act__module___name__post
      parameters:
      - name: module
        in: path
        required: true
        schema:
          type: string
          title: Module
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
  /api/v2/crm/view/{page}:
    get:
      summary: Crm View
      operationId: crm_view_api_v2_crm_view__page__get
      parameters:
      - name: page
        in: path
        required: true
        schema:
          type: string
          title: Page
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
  /api/v2/crm/photo/mailbox/{id}:
    get:
      summary: Crm Mailbox Photo
      description: 'A mailbox''s picture for the pages (their `photoUrl`), through the signed-in relay: the list carries the URL, not the image, and the browser

        keeps what it loaded for a day and asks "changed?" after. The provider fetches ours from the public route instead (outreach_routes).'
      operationId: crm_mailbox_photo_api_v2_crm_photo_mailbox__id__get
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
  /api/v2/crm/search:
    get:
      summary: Crm Search
      operationId: crm_search_api_v2_crm_search_get
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Q
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
  /api/v2/crm/ops/estimate:
    post:
      summary: Ops Estimate
      operationId: ops_estimate_api_v2_crm_ops_estimate_post
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: true
              type: object
              title: Body
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
  /api/v2/crm/ops/execute:
    post:
      summary: Ops Execute
      operationId: ops_execute_api_v2_crm_ops_execute_post
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: true
              type: object
              title: Body
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
  /api/v2/crm/webhooks/sendkit:
    post:
      summary: Sendkit Webhook
      description: 'HMAC-SHA256 of the raw body in X-Webhook-Signature, keyed with the secret stored on the outreach account

        the URL names (`?a=`, set when the webhook was registered).'
      operationId: sendkit_webhook_api_v2_crm_webhooks_sendkit_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - CRM
  /api/v2/crm/webhooks/inboxkit:
    post:
      summary: Inboxkit Webhook
      description: 'The vendor''s "signature" is `sha256=` + the hex SHA-256 of our API key, a static value (not an HMAC of the body).

        The workspace comes from the vendor''s uid, else the domain name or mailbox address, looked up in outreach_routes, never

        from the body''s own workspace fields. Events we don''t handle or can''t place are acknowledged (a refusal counts toward the

        vendor''s circuit breaker), a bad signature is not.'
      operationId: inboxkit_webhook_api_v2_crm_webhooks_inboxkit_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - CRM
  /api/v2/crm/webhooks/unipile:
    post:
      summary: Unipile Webhook
      description: 'The vendor doesn''t sign webhooks. Registered webhooks send our secret in `x-hyreflow-secret`; the

        hosted-auth notify_url carries a per-account HMAC token (?a=&t=) instead.'
      operationId: unipile_webhook_api_v2_crm_webhooks_unipile_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - CRM
  /api/v2/crm/public/mailbox-photo/{id}:
    get:
      summary: Mailbox Photo
      description: 'A mailbox''s profile picture as an image. Public on purpose: the mailbox provider fetches it from here to

        set it on the Google / Microsoft account. The id is an unguessable UUID, and the lookup only answers for

        a workspace with outreach on.'
      operationId: mailbox_photo_api_v2_crm_public_mailbox_photo__id__get
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - CRM
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer