API Docs

Introduction

Seamlessly integrate Flowcase into your ecosystem with our robust APIs. Whether you're synchronising data, automating workflows, or extending Flowcase's functionality, our developer hub provides all the resources you need.

Getting Started

  1. Obtain API Credentials: Create an API key in your Flowcase admin panel. See the Authentication guide for details.
  2. Understand Authentication: All endpoints use the same Bearer token method described in the API specification.
  3. Explore Available Endpoints: Browse the API reference to discover endpoints, required parameters, and example responses.
  4. Make Your First API Call: The Getting Started guide walks through a first request with cURL, Python and Postman.
  5. Stay Updated: Check What's New in the APIs for new features and changes.

Core Resources

  • Users: Manage user accounts with role-based permissions, organisational affiliations, and profile data.
  • Customers and Projects: Access structured reference project data including skills, roles, timelines, and business outcomes for use in proposals as case studies.
  • Résumés/CVs: Create and maintain professional profiles with standardised structure. Manage skills, roles, projects, education, certifications, and other information across multiple languages and content versions.
  • Custom Tags: Categorise entities to enhance searchability and organisation of your data.

Tailoring and Proposals

  • Proposals: Generate tailored documents from user profiles matched to a specific opportunity and its requirements.
  • Templates: Export résumés and projects in a range of templates that match your organisation's branding and the formatting your clients ask for.
  • Content Selection: Control which profile elements appear in each proposal context, based on relevance.

Integration Patterns

  • User Management: Synchronise user data between HR systems and Flowcase using the SCIM v2 and Users API, with Single Sign-On (SSO) for login.
  • Profile Enrichment: Combine user-provided information with HR data sources for complete profiles including education, certifications, and skills via the CVs API.
  • Project Portfolio: Connect CRM or ERP systems such as Salesforce and Deltek Vantagepoint to import and manage customer projects and case studies using the Projects API.
  • Proposal Automation: Create proposals automatically from CRM opportunities and act on proposal status changes using the Proposals API.
  • Analytics and Reporting: Export data in CSV and Excel formats via the Reports API for integration with BI tools.

Need Help?

Contact our support team at techsupport@flowcase.com for any API-related questions.