Use ITFlow's API to work with ITFlow in scripts third-party applications.

The current version of the ITFlow API is v1. It can be accessed at itflow.example.com/api/v1/{module}/{function}.php

1. Login and navigate to the Admin Settings page
2. Select API Keys
3. Select Create to open the New Key modal
4. On Details tab, input the key name and expiration date. Select whether the key will allow access to all clients or a specific client
5. On Keys tab, note down the API key and credential password and select the checkbox to confirm you've made a copy of the keys. You will not see these admin in the admin interface.
6. Select Create to add the key into the database

• assets
• certificates
• clients
• contacts
• credentials (logins)
• documents
• domains
• expenses
• invoices
• locations
• networks
• payments
• products
• quotes
• software
• tickets
• vendors

• read
• create (partial)
• update (partial)
• delete (partial)

• We may also add archive

• GET - Retrieving (READ) data
• POST - Inserting (CREATE), Updating (UPDATE) or Deleting (DELETE) data

• Success - True/False
• Message - Failure info / Helpful debug info
• Count - Count of rows affected/returned
• Data - The data requested/created/changed

• For read requests, 50 records are shown by default. This can be adjusted by supplying the limit and offset parameters.
• For POST requests, the client_id parameter is always required if the API key used has scope/access to all clients
• Be sure to check your Apache/PHP error logs if you're running into issues

Documentation / an example of how to use a module API endpoint is shown on that module's doc page. Additional examples are available here.

Use ITFlow's API to work with ITFlow in scripts and third-party applications.

The current version of the ITFlow API is v1. It can be accessed at itflow.example.com/api/v1/{module}/{function}.php

1. Login and navigate to the Admin Settings page
2. Select API Keys
3. Select Create to open the New Key modal
4. On Details tab, input the key name and expiration date. Select whether the key will allow access to all clients or a specific client
5. On Keys tab, note down the API key and credential password and select the checkbox to confirm you've made a copy of the keys. You will not see these again in the admin interface.
6. Select Create to add the key into the database

• assets
• certificates
• clients
• contacts
• credentials (logins)
• documents
• domains
• expenses
• invoices
• locations
• networks
• payments
• products
• quotes
• software
• tickets
• vendors

• read
• create (partial - see module details)
• update (partial - see module details)
• delete (partial - see module details)
• archive (clients and contacts only)
• unarchive (clients and contacts only)
• resolve (tickets only)

• GET - Retrieving (READ) data
• POST - Inserting (CREATE), Updating (UPDATE), Deleting (DELETE), or Archiving data

• Success - True/False
• Message - Failure info / Helpful debug info
• Count - Count of rows affected/returned
• Data - The data requested/created/changed

• For read requests, 50 records are shown by default. This can be adjusted by supplying the limit and offset parameters.
• For POST requests, the client_id parameter is always required if the API key used has scope/access to all clients
• Be sure to check your Apache/PHP error logs if you're running into issues

Current API v1 Endpoints, Authentication, Examples, and Integration Guide

1. Generate API Key
   1. Login to ITFlow as admin
   2. Navigate to Admin > API
   3. Click New Key
   4. Choose scope: All Clients (for testing) or Specific Client
   5. Copy the generated key

1. Test Connection

curl "https://itflow.yourdomain.com/api/v1/clients/read.php?api_key=YOUR_KEY&limit=1"

1. Expected Response

{
  "success": "True",
  "count": 1,
  "data": [{"client_id": "123", "client_name": "Example Corp"}]
}

• Base URL: /api/v1/{module}/{function}.php
• Version: 1.0 (current)
• Authentication: API Key via query parameter ?api_key=YOUR_KEY
• Response Format: JSON with success, message, count, data fields
• Pagination: Default 50 records, adjustable with limit and offset parameters
• Content-Type: application/json for POST requests
• Character Encoding: UTF-8 (utf8mb4 in database)

{
  "success": "True|False",
  "message": "Descriptive status message",
  "count": 50,
  "data": [
    {
      "id": 123,
      "field": "value"
    }
  ]
}

{
  "success": "True",
  "count": "1",
  "data": [
    {
      "insert_id": 123
    }
  ]
}

• Generation: Admin > API > New Key
• Scoping Options:
  • All Clients (client_id = 0): Full access to all client data
  • Specific Client: Limited to single client data only
• Usage: Query parameter ?api_key=YOUR_KEY for GET, or in JSON body for POST
• Security: Keys stored encrypted in database with expiration dates

• Rotate keys regularly (monthly recommended)
• Use client-scoped keys for third-party integrations
• Store keys securely (environment variables, not code)
• Monitor usage via Apache/PHP logs
• Use HTTPS only for all API calls

Purpose: Computer and equipment inventory management

Available Endpoints:

• GET /read.php - List/get asset information
• POST /create.php - Create new asset record
• POST /update.php - Update existing asset
• POST /delete.php - Delete asset record

Read Parameters (GET):

Create/Update Parameters (POST):

Update Additional Parameters:

Delete Parameters:

<wrap em>Note: Deleting an asset also removes all associated network interfaces.</wrap>

Example - Create Asset:

curl -X POST "https://itflow.example.com/api/v1/assets/create.php" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "YOUR_API_KEY",
    "client_id": 1,
    "asset_name": "DESKTOP-001",
    "asset_type": "Desktop",
    "asset_make": "Dell",
    "asset_model": "OptiPlex 7090",
    "asset_serial": "ABC123XYZ",
    "asset_os": "Windows 11 Pro",
    "asset_ip": "192.168.1.100",
    "asset_mac": "00:11:22:33:44:55",
    "asset_status": "Deployed"
  }'

Purpose: SSL/TLS certificate management and expiration tracking

Available Endpoints:

• GET /read.php - List/get certificate information
• POST /create.php - Create certificate record

<wrap em>Note: Update and delete endpoints are not implemented.</wrap>

Read Parameters (GET):

Create Parameters (POST):

Purpose: Customer/company management

Available Endpoints:

• GET /read.php - List/get client information
• POST /create.php - Create new client
• POST /update.php - Update client details
• POST /archive.php - Archive client
• POST /unarchive.php - Unarchive client

<wrap em>Note: Delete endpoint is not implemented. Use archive instead.</wrap>

Read Parameters (GET):

Create Parameters (POST):

<wrap em>Important: Creating clients requires an API key with “All Clients” scope (client_id = 0).</wrap>

$url = $base_url . 'clients/read.php?api_key=' . $api_key; $response = file_get_contents($url); $data = json_decode($response, true);

print_r($data); ?> </code>

# Get all assets for a client
curl "https://itflow.example.com/api/v1/assets/read.php?api_key=YOUR_KEY&limit=10"
 
# Create a contact
curl -X POST "https://itflow.example.com/api/v1/contacts/create.php" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "YOUR_KEY",
    "client_id": 1,
    "contact_name": "John Smith",
    "contact_email": "john@example.com",
    "contact_phone": "5551234567",
    "contact_primary": 1
  }'