Home
API Reference
List Templates

List Templates

Business+

Read the lists you built in the list builder (booth staff, vehicles and so on) with all their fields, options and rules. Use it to find out which values /list-entries accepts. Fields with writable = false (file fields) cannot be set through the API.

Read Only This endpoint only supports GET requests.

Required scopes: lists

Access level: GET lists:read About access levels

Feature flag: lists

Endpoints

GET


                    /api/v1/list-templates

List the list templates (active ones by default; is_active=all for every row)

GET


                    /api/v1/list-templates/{id}

Retrieve a single list template with its fields

Query Parameters

Parameter	Description
`parent_entity_type`	event_participant (default), event or contact
`is_active`	Default: active entries only; 0 = only inactive, all = every entry

Response Schema

Field	Type
`id`	integer
`template_key`	string
`name`	string
`description`	string\|null
`parent_entity_type`	string
`category_keys`	array
`event_keys`	array
`exhibitor_access`	string
`min_entries`	integer
`max_entries`	integer\|null
`is_active`	boolean
`entry_count`	integer
`fields`	array

Code Examples

curl -X GET "https://your-tenant.plandocket.com/api/v1/list-templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://your-tenant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/list-templates',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/list-templates`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://your-tenant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
}

response = requests.get(f'{base_url}/api/v1/list-templates', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK

{
    "data": [
        {
            "id": 1,
            "template_key": "string",
            "name": "string",
            "description": "string",
            "parent_entity_type": "string",
            "category_keys": [],
            "event_keys": [],
            "exhibitor_access": "string",
            "min_entries": 1,
            "max_entries": 1,
            "is_active": true,
            "entry_count": 1,
            "fields": []
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}

Submission Types List Entries