PeekList

POST

https://api.cbf.tcn.com/api/v0alpha/lms/lists/preview

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "element_id": "string",
    "version": 0,
    "page_size": 0,
    "page": 0,
    "process": {
        "api_entrypoint": {
            "fts_id": "string",
            "file_template_id": "string",
            "incremental": true,
            "encrypted": true
        }
    },
    "peek_at_discards": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/lms/lists/preview' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "element_id": "string",
    "version": 0,
    "page_size": 0,
    "page": 0,
    "process": {
        "api_entrypoint": {
            "fts_id": "string",
            "file_template_id": "string",
            "incremental": true,
            "encrypted": true
        }
    },
    "peek_at_discards": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "records": [
        {
            "fields": [
                {
                    "bool_value": true
                }
            ]
        }
    ],
    "metrics": {
        "input_record_count": 0,
        "output_record_count": 0,
        "field_names": [
            "string"
        ],
        "field_types": [
            "RECORD_TYPE_ALL"
        ],
        "ftypes": [
            "FIELD_TYPE_STRING"
        ],
        "field_counts": [
            0
        ],
        "run_type": "RUN_TYPE_ENABLED",
        "success_message": "string",
        "max_record_width": 0,
        "min_record_width": 0,
        "max_record_index": 0,
        "min_record_index": 0,
        "files": [
            "string"
        ],
        "groups": [
            "string"
        ],
        "missing_fields": [
            "string"
        ],
        "seconds_to_start": 0,
        "seconds_to_process": 0
    }
}

🟢200Success

Modified at 2025-09-26 15:44:58

ListCampaignLinks

GetHistory