Skip to main content
GET
List call flags by task type
Retrieve the approved public call flags for a task type. Use the returned names and descriptions to populate your integration’s event configuration without hardcoding flag codes on your side.

Request

taskType is required and case-sensitive: These are the values published by List Origination Task Types and List Collections Task Types. Both origination types return exactly the same catalog. For each task type, the catalog is identical for all authenticated companies. It does not indicate whether a workflow is enabled for your account.

Response

HTTP 200 returns an array of {name, description} objects, ordered alphabetically by name, with no pagination. name is the case-sensitive flag code to use in configuration; description explains its meaning for your UI. The OpenAPI examples show the complete current catalogs. This is a deliberately selected public catalog. It is not an exhaustive inventory of every flag that may appear in call results. Use codes as identifiers and display descriptions as text. Retrieve the catalog when loading configuration; it does not need to be fetched after every call. Successful responses use Cache-Control: private, max-age=3600: private clients may reuse the response for one hour, while shared caches must not store it. Cache each taskType URL separately and refresh after expiry. Clients that do not implement HTTP caching must explicitly implement reuse; the header alone does not prevent requests. Catalog updates can take up to one hour to appear in a fresh client cache. Requests reaching the API still require a valid API key.

Available flags

In this table, Origination applies to both PendingLoanNewLead and PendingLoanReturning.

Configuring actions

Your integration decides which action to associate with each returned flag. For cancellation actions, retrieve the available reasons from List Stop Servicing Reasons. A flag code and a stop-servicing reason are separate values; do not assume their names match or that every flag requires cancellation. This endpoint provides definitions only. It does not deliver events, configure webhook URLs or credentials, or cancel servicing. Coordinate call-result delivery with your existing integration setup.

Errors

Authentication errors contain a string detail. Query validation errors contain an array of errors in detail, including each error’s loc, msg, and type.

Authorizations

X-API-Key
string
header
required

Query Parameters

taskType
enum<string>
required

Case-sensitive task type from the origination or collections task-type catalog.

Available options:
PendingLoanNewLead,
PendingLoanReturning,
Collections

Response

Approved public integration flags for the requested task type.

name
string
required

Case-sensitive flag code used in call results.

description
string
required

Human-readable explanation of the flag.