Altafid Developer Guide

Complete API reference for third-party integrations with the Altafid platform. Covers authentication, entity management, saved views, tenant administration, staff management, and data export.

Base URL: https://api.altafid.dev.altafid.net
Audience: External vendors and integration partners
Primary auth model: JWT bearer token plus tenant and user headers

Getting started

Core domains

Platform

Reference

What this guide covers

  • Authentication, token refresh, and MFA flows
  • Required request headers and tenant scoping
  • Contacts, organisations, households, and notes APIs
  • Saved views with per-user column and filter persistence
  • Tenant administration, branding, and custom domain management
  • Staff management including credentials and role assignments
  • Tabular data export to CSV and XLSX
  • Pagination, filtering, sample data, and error patterns

Recommended reading order

  1. Use Quick Start to get a working login and first successful request.
  2. Read Shared Conventions for headers, paging, filtering, and failure handling.
  3. Review Authentication and MFA before implementing token lifecycle logic.
  4. Move to the domain page that matches your integration surface.