Zum Hauptinhalt springen

Target Audience

The heycreo developer & API platform serves two main target audiences, each with different access patterns and use cases.

Organizations​

Organizations are the primary users of the heycreo API. An organization represents a single company, team, or entity that uses heycreo to create, manage, and export creative content for their own needs.

Characteristics:

  • Single organization context: All API operations are scoped to one organization
  • Direct access: Organizations work directly with their own templates, designs, assets, and exports
  • Self-contained: Each organization manages its own resources independently

Use Cases:

  • Create and manage templates for internal use
  • Generate designs and exports for marketing campaigns
  • Manage assets and organize content
  • Integrate heycreo into existing workflows and systems
  • Automate content generation from data sources

API Access: Organizations use the standard API endpoints with their organization context. All endpoints are scoped to the authenticated organization, ensuring data isolation and security.

Partners (Agencies)​

Partners are organizations that manage multiple client organizations. They use the Partner API to provide white-label access to heycreo for their clients, enabling multi-tenant management and client administration.

Characteristics:

  • Multi-tenant management: Partners can create and manage multiple client organizations
  • White-label access: Clients receive their own isolated heycreo environment
  • Centralized administration: Partners manage client settings, users, templates, and assets across all clients
  • Client isolation: Each client organization operates independently with its own data

Use Cases:

  • Agencies managing multiple client accounts
  • White-label solutions for resellers
  • Platform providers offering heycreo as a service
  • Managing client organizations, users, and resources
  • Providing branded experiences for each client

API Access: Partners use the Partner API endpoints (prefixed with /organizations/:organizationId/clients) to:

  • Create and manage client organizations
  • Manage users across client organizations
  • Configure client-specific settings (templates, color palettes, fonts, format presets)
  • Access and manage client resources (assets, designs, exports)
  • Set client limits and quotas

Partner API Endpoints:

  • Client Management: Create, update, archive, and list client organizations
  • Client Users: Manage users within client organizations
  • Client Templates: Manage templates for specific clients
  • Client Assets: Manage assets within client organizations
  • Client Configuration: Set color palettes, fonts, format presets, and other client-specific settings

Authentication​

Both organization and partner API access use the same authentication mechanism (JWT tokens or API keys), but the available endpoints and permissions differ based on the organization type and user role. Partners require specific permissions to access client management endpoints.

See also​