API Docs / Operations / Service - Onboarding Tasks / List OnboardingTaskTemplates

List OnboardingTaskTemplates

GET /tenants/{tenant}/onboarding-task-templates

Lists all OnboardingTaskTemplates for the given tenant.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

DueDateOffsetDays Name

Field to sort by.

DueDateOffsetDays Name

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

serviceCode query string

Filter by billable service code

Filter by billable service code

isActive query boolean

Filter by active status (true = active only, false = inactive only)

Filter by active status (true = active only, false = inactive only)

search query string

Search across template code, name, and description (minimum 3 characters)

Search across template code, name, and description (minimum 3 characters)

Responses

401 Unauthorized – Invalid or missing API key