Configuration API

Administrative APIs for configuring your loyalty platform. These endpoints manage authentication, programs, rules, offers, and data models that define how your loyalty system operates.

Auth & Access

Configure authentication, authorization, and access control for your platform.

Auth UsersAuthentication user lookupLogin UsersLogin user managementM2M ClientsMachine-to-machine credentialsRolesRole definitions and assignmentsScopesPermission scope definitions

Organizations

Manage organizations and their deployment environments.

OrganizationsOrganization setupEnvironmentsEnvironment configuration

Programs

Define loyalty programs, tiers, badges, and customer audiences.

ProgramsProgram definitionsTiersTier level configurationBadgesBadge definitionsProgram CurrenciesCurrency typesPartnersPartner integrationsCustomer AudiencesAudience segmentation

Rules

Configure event processing rules, targets, and balance policies.

Event RulesEvent rule definitionsEvent Type ConfigEvent type settingsTargetsTarget definitionsPending RulesPending balance rulesExpiry RulesBalance expiration rules

Offers

Configure promotional offers and coupon templates.

OffersOffer and promotion setup

Data Models

Define custom data structures and schemas for your platform.

Data ModelsCustom data model definitionsElementsData model field definitionsSchemasJSON schema retrievalData TypesPrimitive data types

Metadata

Manage reference data including items, locations, and custom metadata.

MetadataGeneral metadata entriesMetadata TypesMetadata categorizationMetadata GroupsMetadata groupingsItemsProduct/item reference dataLocationsLocation reference dataTypesData model type registry

Hub

Configure the Loom Loyalty Hub portal, including domains, components, and settings.

Hub ConfigsHub configuration settingsHub DomainsCustom domain managementHub ComponentsCustom component definitions

Workflows

Configure approval workflows for environment promotions.

Environment WorkflowsWorkflow definitionsWorkflow RequestsApproval requestsEnable PoliciesEnable policies

Schema

Access the OpenAPI specification for this API.

OpenAPI SpecificationAPI schema export