API Documentation

Appearance

Engagifii Relationships API Documentation ​

Table of Contents ​

Project Overview ​

The Engagifii Relationships API is a comprehensive RESTful web service that provides customer relationship management capabilities for organizations, committees, and advocacy efforts. Built on .NET Core 2.1, this multi-tenant enterprise API enables external developers to integrate powerful CRM functionality into their applications.

Core Capabilities ​

  • People Management: Complete person lifecycle management with detailed profiles, relationships, and contact information
  • Organization Management: Hierarchical organization structures with relationship mapping and contact management
  • Committee Operations: Committee creation, member management, and position tracking
  • Advocacy Tools: Political relationship mapping, constituency management, and official connections
  • Communication Hub: Email integration, mailing lists, and message broadcasting
  • Data Export: Flexible reporting and data export capabilities
  • Multi-tenancy: Secure tenant isolation with configurable settings per organization

Key Features ​

  • RESTful Architecture: Standard HTTP methods with JSON request/response format
  • Multi-tenant Security: Tenant-based data isolation and access control
  • Comprehensive Search: Advanced filtering and search capabilities across all entities
  • Real-time Updates: SignalR integration for live data updates
  • Bulk Operations: Efficient batch processing for large datasets
  • Integration Ready: OAuth2 authentication with external system compatibility

Quick Start Guide ​

Get up and running with the Engagifii Relationships API in under 5 minutes:

1. Get Your Credentials ​

Contact your system administrator to obtain:

  • Client ID: Your application identifier
  • Client Secret: Your application secret key
  • Tenant Code: Your organization's unique tenant identifier

2. Authentication ​

bash
# Get an access token
curl -X POST "https://builtin-crm.azurewebsites.net/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

3. Make Your First API Call ​

bash
# List all people in your organization
curl -X GET "https://builtin-crm.azurewebsites.net/api/v1/people" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "tenant-code: YOUR_TENANT_CODE"

4. Next Steps ​

Base URLs ​

EnvironmentBase URLDescription
Productionhttps://builtin-crm.azurewebsites.netLive production environment
Staginghttps://staging-crm.azurewebsites.netPre-production testing
Developmenthttps://dev-crm.azurewebsites.netDevelopment and integration testing

Note: All API endpoints are prefixed with /api/v{version} where version is the API version (currently 1).

API Versioning ​

The Engagifii Relationships API uses URL-based versioning to ensure backward compatibility and smooth transitions between API versions.

Current Version: v1 ​

  • URL Format: /api/v1/{endpoint}
  • Status: Stable and fully supported
  • Deprecation: No deprecation planned

Version Headers ​

All requests must include the API version in the URL path:

GET /api/v1/people HTTP/1.1
Host: builtin-crm.azurewebsites.net

Breaking Changes Policy ​

  • Major version increments (v1 → v2) may include breaking changes
  • Minor updates within a version maintain backward compatibility
  • Deprecated endpoints will be supported for at least 12 months after deprecation notice

Support Information ​

Documentation Resources ​

Interactive Tools ​

Getting Help ​

  • Technical Documentation: Review our comprehensive guides above
  • Integration Examples: Check the integration-examples directory
  • Community Support: Join our developer community forum
  • Enterprise Support: Contact your account manager for priority assistance

Reporting Issues ​

Found a bug or have a feature request?

  • Bug Reports: Use the issue tracking system provided by your organization
  • Feature Requests: Submit enhancement requests through your account manager
  • Security Issues: Report security vulnerabilities through secure channels only

Documentation Navigation ​

This documentation is organized into focused sections for different aspects of API integration:

For New Developers ​

  1. Getting Started - Complete onboarding guide
  2. Authentication - Security setup and token management
  3. Quick Reference - Essential endpoints and examples

For Integration Development ​

  1. API Reference - Complete endpoint documentation
  2. Data Models - Request/response schemas
  3. Error Handling - Error management strategies

For Advanced Use Cases ​

  1. Integration Examples - Code samples and patterns
  2. OpenAPI Specification - Machine-readable API definition
  3. Postman Collection - Pre-built API requests

Last Updated: Generated automatically from API version 1.0 API Version: v1 Documentation Version: 1.0.0

Copyright © 2025 Engagifii