Fax for Agents

Fax for Agents Approvals API

The approvals API from Fax for Agents — 5 operation(s) for approvals.

GitHub OpenAPI

Operations 6

POST /v1/approval-requests Ask a human to approve a quoted send, or ask for help (grants nothing) #
GET /v1/approval-requests Approval requests, pending first #
GET /v1/approval-requests/{approval_id} Read one request #
POST /v1/approval-requests/{approval_id}/approve Approve the bound quote (a human with approval:decide, never the requester) #
POST /v1/approval-requests/{approval_id}/reject Reject with a reason #
POST /v1/approvals/{approval_id}/revoke Revoke an approval nobody has used yet #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-approvals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-extraction-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-fax-job-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-quote-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-inbox-item-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-analytics-organization-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-number-schema.json

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/faxforagents:faxforagents-approvals-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

faxforagents-approvals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Approvals API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged approvals across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: Approvals
paths:
  /v1/approval-requests:
    post:
      tags:
      - Approvals
      summary: Ask a human to approve a quoted send, or ask for help (grants nothing)
      operationId: create_approval_request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalRequestCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRequest'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Approvals
      summary: Approval requests, pending first
      operationId: list_approval_requests
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRequestPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/approval-requests/{approval_id}:
    get:
      tags:
      - Approvals
      summary: Read one request
      operationId: get_approval_request
      parameters:
      - name: approval_id
        in: path
        required: true
        schema:
          type: string
          title: Approval Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRequest'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/approval-requests/{approval_id}/approve:
    post:
      tags:
      - Approvals
      summary: Approve the bound quote (a human with approval:decide, never the requester)
      operationId: approve_request
      parameters:
      - name: approval_id
        in: path
        required: true
        schema:
          type: string
          title: Approval Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalDecision'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRequest'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/approval-requests/{approval_id}/reject:
    post:
      tags:
      - Approvals
      summary: Reject with a reason
      operationId: reject_request
      parameters:
      - name: approval_id
        in: path
        required: true
        schema:
          type: string
          title: Approval Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalDecision'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRequest'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/approvals/{approval_id}/revoke:
    post:
      tags:
      - Approvals
      summary: Revoke an approval nobody has used yet
      operationId: revoke_approval
      parameters:
      - name: approval_id
        in: path
        required: true
        schema:
          type: string
          title: Approval Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApprovalDecision'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalRequest'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    ApprovalRequest:
      properties:
        id:
          type: string
          title: Id
        kind:
          type: string
          enum:
          - send
          - help
          title: Kind
        status:
          type: string
          enum:
          - pending
          - approved
          - rejected
          - revoked
          - expired
          title: Status
        quote_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Quote Id
        bound:
          additionalProperties: true
          type: object
          title: Bound
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        requested_by:
          type: string
          title: Requested By
        decided_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Decided By
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
        consumed_by_job_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Consumed By Job Id
        created_at:
          type: string
          title: Created At
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        decided_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Decided At
        notified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Notified
          description: 'On creation: whether the organization was mailed. false when the request repeats a pending one or the organization''s daily cap of request mails is reached; the request is still shown in the dashboard.'
      additionalProperties: true
      type: object
      required:
      - id
      - kind
      - status
      - quote_id
      - bound
      - message
      - requested_by
      - decided_by
      - reason
      - consumed_by_job_id
      - created_at
      - expires_at
      - decided_at
      title: ApprovalRequest
    ApprovalRequestCreate:
      properties:
        kind:
          type: string
          enum:
          - send
          - help
          title: Kind
          default: send
        quote_id:
          anyOf:
          - type: string
            pattern: ^[a-z]{2,8}_[0-9a-f]{32}$
          - type: 'null'
          title: Quote Id
          description: The quote to bind (kind send).
        message:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Message
          description: What the person should know (kind help). Shown as data.
        fax_job_id:
          anyOf:
          - type: string
            pattern: ^[a-z]{2,8}_[0-9a-f]{32}$
          - type: 'null'
          title: Fax Job Id
      additionalProperties: false
      type: object
      title: ApprovalRequestCreate
    ApprovalDecision:
      properties:
        reason:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Reason
      additionalProperties: false
      type: object
      title: ApprovalDecision
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ApprovalRequestPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ApprovalRequest'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: ApprovalRequestPage
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json