Catalog

Catalog endpoints are read-only discovery endpoints. Use them before creating a job to learn what Fictix can generate and how returned records will look.

Base path:

/api/v1/catalog

For how catalog results map to project runtime calls, see the Capability Matrix.

Authentication: none. Catalog endpoints are public discovery endpoints and contain no organization, project, credential, or generated tenant data.

List archetypes

GET/api/v1/catalog/archetypes
GET /api/v1/catalog/archetypes

Returns supported company archetypes and key generation defaults.

Response shape:

{
  "object": "catalog_collection",
  "contract_version": "2026-07-17",
  "collection": "archetypes",
  "count": 3,
  "items": [
    {
      "id": "saas_b2b",
      "name": "Saas B2B",
      "customers_per_employee": 3.0,
      "payment_rate": 0.92,
      "monthly_churn_rate": 0.02
    }
  ]
}

Use this to populate archetype pickers or to validate user input before job creation.

List quality presets

GET/api/v1/catalog/presets
GET /api/v1/catalog/presets

Returns:

  • clean
  • realistic
  • messy
  • stress_test

Response item:

{
  "id": "realistic",
  "name": "Realistic",
  "description": "Minor real-world defects without breaking core workflows.",
  "defect_rate": 0.05
}

List entities

GET/api/v1/catalog/entities
GET /api/v1/catalog/entities

Returns the public entity families available through demo-job entity APIs.

Use this endpoint to:

  • build entity browsers
  • choose loader order
  • validate export requests
  • show users what data is available

List services

GET/api/v1/catalog/services
GET /api/v1/catalog/services

Returns supported connector/service families and visible record types.

Use this endpoint when presenting selected services in a create-job UI.

List connector capabilities

GET/api/v1/catalog/connector-capabilities
GET /api/v1/catalog/connector-capabilities

Query params:

Name Type Default Description
include_unsupported boolean false Include unsupported connector manifests.

Response includes:

  • total count
  • selectable count
  • unsupported count
  • capability metadata per connector

List export packs

GET/api/v1/catalog/export-packs
GET /api/v1/catalog/export-packs

Returns shipped file-oriented export packs such as QBO, HubSpot, Asana, and captured provider packs.

Use this when the host product wants a file import path instead of a JSON API path.

Get service object schema

GET/api/v1/catalog/services/{service_id}/objects/{object_type}/schema
GET /api/v1/catalog/services/{service_id}/objects/{object_type}/schema

Examples:

GET /api/v1/catalog/services/qbo/objects/invoice/schema
GET /api/v1/catalog/services/stripe/objects/customer/schema

Returns display columns for generic and native-shaped object views.

Get export pack schema

GET/api/v1/catalog/export-packs/{target}/schema
GET /api/v1/catalog/export-packs/qbo/schema
GET /api/v1/catalog/export-packs/{target}/schema

Use schema endpoints to:

  • display available CSV files
  • validate import tooling
  • generate docs for export bundles
  • compare expected files against downloaded artifacts