API Documentation

API Endpoint

Integrations

Integrations

Supported filter params

  • integration_type_id

  • jira_organization

  • jira_project

  • project_id

  • deal_id

  • subsidiary_id

  • project_status (1: active, 2: archived)

Supported sort params

  • id

  • created_at

GET /api/v2/integrations
Requestsreturns integrations

GET  /api/v2/integrations

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "7",
      "type": "integrations",
      "attributes": {
        "name": null,
        "integration_type_id": 2,
        "realm_id": null,
        "requested_at": null,
        "request_token": null,
        "request_uri": null,
        "connected_at": null,
        "account_code": null,
        "deactivated_at": null,
        "options": {},
        "export_number": false,
        "export_attachment": null,
        "export_expense_attachment": null,
        "use_expense_sync": null,
        "quickbooks_default_expense_account_code": null,
        "quickbooks_default_expense_bank_account_code": null,
        "quickbooks_default_expense_payment_type": null,
        "expense_account_code_mapping": null,
        "payments_import": null,
        "redirect_uri": null,
        "calendars": null,
        "exact_country": null,
        "exact_divisions": null,
        "exact_division": null,
        "exact_division_id": null,
        "xero_invoice_status_id": null,
        "xero_expense_status_id": null,
        "account_code_mapping": null,
        "xero_reference": null,
        "xero_internal_note_cf_id": null,
        "item_mapping": null,
        "quickbooks_memo": null,
        "customer_memo_cf_id": null,
        "default_item": null,
        "calendar_write_status": null,
        "calendar_write_options": null,
        "google_events_write_scope": null,
        "import_attachment": null,
        "economic_product_mapping": null,
        "default_product": null,
        "slack_options": {
          "notifications": null,
          "status_sync": null,
          "unfurl_setting_id": null,
          "unfurl_type_id": null,
          "event_ids": null
        },
        "fortnox_default_account": null,
        "fortnox_default_article": null,
        "fortnox_article_mapping": null,
        "fortnox_account_mapping": null,
        "last_synced_at": null,
        "exact_ledger_manually": null,
        "exact_default_ledger": null,
        "exact_ledger_mapping": null,
        "exact_default_journal": null,
        "twinfield_offices": null,
        "twinfield_invoice_destiny": null,
        "twinfield_default_ledger": null,
        "twinfield_ledger_mapping": null,
        "twinfield_default_project": null,
        "twinfield_project_mapping": null,
        "twinfield_default_cost_center": null,
        "twinfield_cost_center_mapping": null,
        "hubspot_default_subsidiary_id": null,
        "hubspot_default_deal_owner_id": null,
        "hubspot_default_company_id": null,
        "hubspot_default_template_id": null,
        "hubspot_stages_mapping": null,
        "hubspot_sync_deals": null,
        "hubspot_pipelines": null,
        "sage_default_ledger": null,
        "sage_ledger_mapping": null,
        "sage_country": null,
        "sage_business_name": null,
        "tax_rate_mapping": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "610"
          }
        },
        "subsidiary": {
          "meta": {
            "included": false
          }
        },
        "project": {
          "meta": {
            "included": false
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "deal": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/integrations?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get integration
GET/api/v2/integrations

GET /api/v2/integrations/1
Requestsreturns integration

GET  /api/v2/integrations/8

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "8",
    "type": "integrations",
    "attributes": {
      "name": null,
      "integration_type_id": 2,
      "realm_id": null,
      "requested_at": null,
      "request_token": null,
      "request_uri": null,
      "connected_at": null,
      "account_code": null,
      "deactivated_at": null,
      "options": {},
      "export_number": false,
      "export_attachment": null,
      "export_expense_attachment": null,
      "use_expense_sync": null,
      "quickbooks_default_expense_account_code": null,
      "quickbooks_default_expense_bank_account_code": null,
      "quickbooks_default_expense_payment_type": null,
      "expense_account_code_mapping": null,
      "payments_import": null,
      "redirect_uri": null,
      "calendars": null,
      "exact_country": null,
      "exact_divisions": null,
      "exact_division": null,
      "exact_division_id": null,
      "xero_invoice_status_id": null,
      "xero_expense_status_id": null,
      "account_code_mapping": null,
      "xero_reference": null,
      "xero_internal_note_cf_id": null,
      "item_mapping": null,
      "quickbooks_memo": null,
      "customer_memo_cf_id": null,
      "default_item": null,
      "calendar_write_status": null,
      "calendar_write_options": null,
      "google_events_write_scope": null,
      "import_attachment": null,
      "economic_product_mapping": null,
      "default_product": null,
      "slack_options": {
        "notifications": null,
        "status_sync": null,
        "unfurl_setting_id": null,
        "unfurl_type_id": null,
        "event_ids": null
      },
      "fortnox_default_account": null,
      "fortnox_default_article": null,
      "fortnox_article_mapping": null,
      "fortnox_account_mapping": null,
      "last_synced_at": null,
      "exact_ledger_manually": null,
      "exact_default_ledger": null,
      "exact_ledger_mapping": null,
      "exact_default_journal": null,
      "twinfield_offices": null,
      "twinfield_invoice_destiny": null,
      "twinfield_default_ledger": null,
      "twinfield_ledger_mapping": null,
      "twinfield_default_project": null,
      "twinfield_project_mapping": null,
      "twinfield_default_cost_center": null,
      "twinfield_cost_center_mapping": null,
      "hubspot_default_subsidiary_id": null,
      "hubspot_default_deal_owner_id": null,
      "hubspot_default_company_id": null,
      "hubspot_default_template_id": null,
      "hubspot_stages_mapping": null,
      "hubspot_sync_deals": null,
      "hubspot_pipelines": null,
      "sage_default_ledger": null,
      "sage_ledger_mapping": null,
      "sage_country": null,
      "sage_business_name": null,
      "tax_rate_mapping": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "611"
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets an integration
GET/api/v2/integrations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

integration id

POST /api/v2/integrations
Requestscreates integrationcreates integrationreturns errorreturns errorreturns errorreturns error

POST  /api/v2/integrations

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "integrations",
    "attributes": {
      "redirect_uri": "http://app.productive.io.localhost/integrations/quickbooks",
      "integration_type_id": 2
    },
    "relationships": {
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "698"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "10",
    "type": "integrations",
    "attributes": {
      "name": null,
      "integration_type_id": 2,
      "realm_id": null,
      "requested_at": "2025-07-17T06:05:50.000+02:00",
      "request_token": "cf4e6937d12072528f16ac2a",
      "request_uri": "https://appcenter.intuit.com/connect/oauth2?client_id=Q08lq2LdTQpor8vzsmrd0hsOMTJIspIyLFrkMzVnVrumGE4Rq7&redirect_uri=http%3A%2F%2Fapp.productive.io.localhost%2Fintegrations%2Fquickbooks&response_type=code&scope=com.intuit.quickbooks.accounting&state=612%2F10%2Fcf4e6937d12072528f16ac2a",
      "connected_at": null,
      "account_code": null,
      "deactivated_at": null,
      "options": {},
      "export_number": false,
      "export_attachment": null,
      "export_expense_attachment": null,
      "use_expense_sync": null,
      "quickbooks_default_expense_account_code": null,
      "quickbooks_default_expense_bank_account_code": null,
      "quickbooks_default_expense_payment_type": null,
      "expense_account_code_mapping": null,
      "payments_import": null,
      "redirect_uri": null,
      "calendars": null,
      "exact_country": null,
      "exact_divisions": null,
      "exact_division": null,
      "exact_division_id": null,
      "xero_invoice_status_id": null,
      "xero_expense_status_id": null,
      "account_code_mapping": null,
      "xero_reference": null,
      "xero_internal_note_cf_id": null,
      "item_mapping": null,
      "quickbooks_memo": null,
      "customer_memo_cf_id": null,
      "default_item": null,
      "calendar_write_status": null,
      "calendar_write_options": null,
      "google_events_write_scope": null,
      "import_attachment": null,
      "economic_product_mapping": null,
      "default_product": null,
      "slack_options": {
        "notifications": null,
        "status_sync": null,
        "unfurl_setting_id": null,
        "unfurl_type_id": null,
        "event_ids": null
      },
      "fortnox_default_account": null,
      "fortnox_default_article": null,
      "fortnox_article_mapping": null,
      "fortnox_account_mapping": null,
      "last_synced_at": null,
      "exact_ledger_manually": null,
      "exact_default_ledger": null,
      "exact_ledger_mapping": null,
      "exact_default_journal": null,
      "twinfield_offices": null,
      "twinfield_invoice_destiny": null,
      "twinfield_default_ledger": null,
      "twinfield_ledger_mapping": null,
      "twinfield_default_project": null,
      "twinfield_project_mapping": null,
      "twinfield_default_cost_center": null,
      "twinfield_cost_center_mapping": null,
      "hubspot_default_subsidiary_id": null,
      "hubspot_default_deal_owner_id": null,
      "hubspot_default_company_id": null,
      "hubspot_default_template_id": null,
      "hubspot_stages_mapping": null,
      "hubspot_sync_deals": null,
      "hubspot_pipelines": null,
      "sage_default_ledger": null,
      "sage_ledger_mapping": null,
      "sage_country": null,
      "sage_business_name": null,
      "tax_rate_mapping": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "612"
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create an integration
POST/api/v2/integrations

URI Parameters
HideShow
name
string (optional) Example: Name

name

integration_type_id
number (required) Example: 1

integration type id

DELETE /api/v2/integrations/1
Requestsdeletes integration

DELETE  /api/v2/integrations/21

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes an integration
DELETE/api/v2/integrations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

integration id

GET /api/v2/integrations/1/check
Requestsreturns integrationraises error

GET  /api/v2/integrations/28/check

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "28",
    "type": "integrations",
    "attributes": {
      "name": null,
      "integration_type_id": 2,
      "realm_id": null,
      "requested_at": null,
      "request_token": null,
      "request_uri": null,
      "connected_at": null,
      "account_code": null,
      "deactivated_at": null,
      "options": {},
      "export_number": false,
      "export_attachment": null,
      "export_expense_attachment": null,
      "use_expense_sync": null,
      "quickbooks_default_expense_account_code": null,
      "quickbooks_default_expense_bank_account_code": null,
      "quickbooks_default_expense_payment_type": null,
      "expense_account_code_mapping": null,
      "payments_import": null,
      "redirect_uri": null,
      "calendars": null,
      "exact_country": null,
      "exact_divisions": null,
      "exact_division": null,
      "exact_division_id": null,
      "xero_invoice_status_id": null,
      "xero_expense_status_id": null,
      "account_code_mapping": null,
      "xero_reference": null,
      "xero_internal_note_cf_id": null,
      "item_mapping": null,
      "quickbooks_memo": null,
      "customer_memo_cf_id": null,
      "default_item": null,
      "calendar_write_status": null,
      "calendar_write_options": null,
      "google_events_write_scope": null,
      "import_attachment": null,
      "economic_product_mapping": null,
      "default_product": null,
      "slack_options": {
        "notifications": null,
        "status_sync": null,
        "unfurl_setting_id": null,
        "unfurl_type_id": null,
        "event_ids": null
      },
      "fortnox_default_account": null,
      "fortnox_default_article": null,
      "fortnox_article_mapping": null,
      "fortnox_account_mapping": null,
      "last_synced_at": null,
      "exact_ledger_manually": null,
      "exact_default_ledger": null,
      "exact_ledger_mapping": null,
      "exact_default_journal": null,
      "twinfield_offices": null,
      "twinfield_invoice_destiny": null,
      "twinfield_default_ledger": null,
      "twinfield_ledger_mapping": null,
      "twinfield_default_project": null,
      "twinfield_project_mapping": null,
      "twinfield_default_cost_center": null,
      "twinfield_cost_center_mapping": null,
      "hubspot_default_subsidiary_id": null,
      "hubspot_default_deal_owner_id": null,
      "hubspot_default_company_id": null,
      "hubspot_default_template_id": null,
      "hubspot_stages_mapping": null,
      "hubspot_sync_deals": null,
      "hubspot_pipelines": null,
      "sage_default_ledger": null,
      "sage_ledger_mapping": null,
      "sage_country": null,
      "sage_business_name": null,
      "tax_rate_mapping": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "625"
        }
      },
      "subsidiary": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "deal": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Checks if integration is valid
GET/api/v2/integrations/{id}/check

URI Parameters
HideShow
id
number (required) Example: 1

integration id

Generated by aglio on 17 Jul 2025