Lists the Terminal49 template definitions. It does not return the definitions configured for your account. To list those, use List account custom field definitions.
Pagination links. Each value is an absolute URL. self repeats the request URL as sent, including its query string and its encoding. current, first, prev, next, and last repeat the request's query parameters, with page[number] and page[size] in unencoded brackets.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Terminal49","description":"Developer documentation for the Terminal49 API, DataSync, SDK, and MCP server for container tracking, shipment visibility, webhooks, and integrations.","colors":{"primary":"#1A9E52","light":"#1A9E52","dark":"#2ACD6C"},"logo":{"light":"https://mintcdn.com/terminal49/vf64v0nfd3Z9JQ4O/logos/light.svg?fit=max\u0026auto=format\u0026n=vf64v0nfd3Z9JQ4O\u0026q=85\u0026s=d4e213611d22dd79c263b9d1ffa46eea","dark":"https://mintcdn.com/terminal49/vf64v0nfd3Z9JQ4O/logos/dark.svg?fit=max\u0026auto=format\u0026n=vf64v0nfd3Z9JQ4O\u0026q=85\u0026s=4458f17b851e3549033b9bedb71fe3ba"},"favicon":"https://mintcdn.com/terminal49/tUOgDh5QtR_8-BBX/logos/favicon.svg?fit=max\u0026auto=format\u0026n=tUOgDh5QtR_8-BBX\u0026q=85\u0026s=cb027195e481e03988cbd56028fc2444","appearance":{"default":"light","strict":false},"navbar":{"links":[{"href":"https://www.terminal49.com/demo","label":"Talk To Us"}],"primary":{"type":"button","label":"Get Started","href":"https://app.terminal49.com/register"}},"footer":{"socials":{"twitter":"https://twitter.com/terminal49","linkedin":"https://www.linkedin.com/company/terminal49"},"links":[{"header":"Resources","items":[{"label":"Blog","href":"https://www.terminal49.com/blog"},{"label":"Contact","href":"https://www.terminal49.com/contact"},{"label":"Book a Demo","href":"https://www.terminal49.com/demo"}]},{"header":"Product","items":[{"label":"Sign in","href":"https://app.terminal49.com/"},{"label":"Start Free Trial","href":"https://app.terminal49.com/register"}]}]},"seo":{"metatags":{"og:type":"website","og:site_name":"Terminal49 Docs","twitter:card":"summary_large_image","twitter:site":"@terminal49"},"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-K8CDPJJG"},"posthog":{"apiKey":"phc_rBNVF6dUk5HU5m3pX9yZZWoehXoqZTCeKXFXCEoJzEyq","apiHost":"https://f.terminal49.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"terminal49","hasAudioNarration":false,"actualSubdomain":"terminal49","customDomains":["terminal49.com"],"gitSource":{"type":"github","owner":"terminal49","repo":"api","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af10f832f2e026614e862e3","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"SDK Docs","count":109},{"language":"default","tag":"API Reference","count":105},{"language":"default","tag":"TypeScript API Reference","count":104},{"language":"default","tag":"Managers","count":42},{"language":"default","tag":"Developer Guide","count":35},{"language":"default","tag":"Models","count":21},{"language":"default","tag":"MCP","count":16},{"language":"default","tag":"Client","count":13},{"language":"default","tag":"Containers","count":11},{"language":"default","tag":"Documents","count":11}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@terminal49.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6921e1f7f5047ea275ad7af0","deploymentId":"660c368041a00f5c82bccd87","questionText":"How do I get the ETA?","status":"active","generatedBy":"manual","createdAt":"2025-11-22T16:16:55.122Z","updatedAt":"2025-11-22T16:16:55.122Z","__v":0},{"_id":"6921e1caf5047ea275ad7837","deploymentId":"660c368041a00f5c82bccd87","questionText":"How do I get a containers LFD (last free day)?","status":"active","generatedBy":"manual","createdAt":"2025-11-22T16:16:10.178Z","updatedAt":"2025-11-22T16:16:10.178Z","__v":0},{"_id":"6921e1b5f5047ea275ad7732","deploymentId":"660c368041a00f5c82bccd87","questionText":"How do I start tracking a bill of lading?","status":"active","generatedBy":"manual","createdAt":"2025-11-22T16:15:49.020Z","updatedAt":"2025-11-22T16:15:49.020Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-docs/api-reference/custom-fields/list-custom-field-definitions","slug":"/api-docs/api-reference/custom-fields/list-custom-field-definitions","pageMetadata":{"title":"List custom field definition templates","description":"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.","og:title":"List Custom Field Definition Templates | Terminal49 API Documentation","og:description":"List the Terminal49 custom field definition templates. Copy a template into your account with the template_id attribute of the account create route.","openapi":"get /custom_field_definitions","href":"/api-docs/api-reference/custom-fields/list-custom-field-definitions"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Lists the Terminal49 template definitions. It does not return the definitions configured for your account. To list those, use `,_jsx(_components.a,{href:`/api-docs/api-reference/custom-fields/list-account-custom-field-definitions`,children:`List account custom field definitions`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`query-filters`,children:`Query filters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Filter`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`filter[entity_type]`})}),_jsxs(_components.td,{children:[`Filter by entity type: `,_jsx(_components.code,{children:`Shipment`}),` or `,_jsx(_components.code,{children:`Cargo`}),` (containers)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`filter[data_type]`})}),_jsx(_components.td,{children:`Filter by data type`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`filter[display_name]`})}),_jsx(_components.td,{children:`Filter by display name (prefix match)`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List custom field definition templates","description":"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.","og:title":"List Custom Field Definition Templates | Terminal49 API Documentation","og:description":"List the Terminal49 custom field definition templates. Copy a template into your account with the template_id attribute of the account create route.","openapi":"get /custom_field_definitions","href":"/api-docs/api-reference/custom-fields/list-custom-field-definitions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Query filters","slug":"query-filters","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/terminal49/bf5953d390eb98ad/segment.js","/docs/_mintlify/custom/terminal49/6a1836b84932e871/webmcp.js"],"openApiReferenceData":{"operation":{"summary":"List custom field definition templates","operationId":"get-custom-field-definitions","tags":["Custom Field Definitions"],"parameters":["1fabf57c-8b02-4715-922e-1fae43802033","052e1111-6102-4f64-8f7b-7c91981acbb2","4b21463c-d1f6-461c-9ebd-57fab7859fdf"],"responses":{"200":"81150730-8752-4562-88a0-6e70689e082b"},"description":"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.","method":"get","type":"path","servers":["716b8bce-f12c-4964-b0ac-d1c057abd32a"],"security":["fa4ae7e9-ba7b-4434-9ac4-ccb8f8dc0459"],"path":"/custom_field_definitions","baseUrlOptions":["https://api.terminal49.com/v2"],"title":"List custom field definition templates","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1fabf57c-8b02-4715-922e-1fae43802033":{"schema":{"type":"string","enum":["Shipment","Cargo"],"description":"Filter by entity type. `Cargo` means containers.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query","name":"filter[entity_type]","description":"Filter by entity type. `Cargo` means containers."},"052e1111-6102-4f64-8f7b-7c91981acbb2":{"schema":{"type":"string","description":"Filter by data type","uniqueKey":"","typeLabel":"string"},"in":"query","name":"filter[data_type]","description":"Filter by data type"},"4b21463c-d1f6-461c-9ebd-57fab7859fdf":{"schema":{"type":"string","description":"Filter by display name (prefix match)","uniqueKey":"","typeLabel":"string"},"in":"query","name":"filter[display_name]","description":"Filter by display name (prefix match)"}},"responses":{"81150730-8752-4562-88a0-6e70689e082b":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"title":"Custom field definition","type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["custom_field_definition"],"isRequired":true,"uniqueKey":"data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","properties":{"entity_type":{"type":"string","enum":["Shipment","Cargo"],"description":"The entity type this definition applies to. `Cargo` means containers.","isRequired":true,"uniqueKey":"data.items.[INDEX].attributes.entity_type","typeLabel":"enum\u003cstring>"},"api_slug":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].attributes.api_slug","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].attributes.display_name","typeLabel":"string"},"data_type":{"type":"string","enum":["short_text","number","date","datetime","boolean","enum","enum_multi","reference"],"isRequired":true,"uniqueKey":"data.items.[INDEX].attributes.data_type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].attributes.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].attributes.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].attributes.description","typeLabel":"string | null"},"reference_type":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].attributes.reference_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].attributes.reference_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].attributes.reference_type","typeLabel":"string | null"},"validation":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"data.items.[INDEX].attributes.validation.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"data.items.[INDEX].attributes.validation.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].attributes.validation","typeLabel":"object | null"},"default_format":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].attributes.default_format.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].attributes.default_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].attributes.default_format","typeLabel":"string | null"},"default_value":{"oneOf":[{"type":"string","description":"Raw custom field value (type depends on definition)","uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Raw custom field value (type depends on definition)","uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.1","typeLabel":"null"},{"type":"number","description":"Raw custom field value (type depends on definition)","uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Raw custom field value (type depends on definition)","uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.3","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.4.items.[INDEX]","typeLabel":"string"},"description":"Raw custom field value (type depends on definition)","uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.4","typeLabel":"string[]"},{"type":"object","description":"Raw custom field value (type depends on definition)","additionalProperties":true,"uniqueKey":"data.items.[INDEX].attributes.default_value.oneOf.5","typeLabel":"object"}],"uniqueKey":"data.items.[INDEX].attributes.default_value","typeLabel":"string | null | number | boolean | string[] | object"},"reference_number":{"type":"boolean","description":"Whether values are reference numbers. Terminal49 indexes reference-number values on account definitions for global search and document matching.","uniqueKey":"data.items.[INDEX].attributes.reference_number","typeLabel":"boolean"},"sensitive":{"type":"boolean","description":"Whether the field is sensitive. Sensitive fields are hidden from recipients of externally shared container views.","uniqueKey":"data.items.[INDEX].attributes.sensitive","typeLabel":"boolean"},"inline_option_creation":{"type":"boolean","description":"Whether users can add a new option while entering an `enum` or `enum_multi` value in the Terminal49 app.","uniqueKey":"data.items.[INDEX].attributes.inline_option_creation","typeLabel":"boolean"},"template_id":{"oneOf":[{"type":"string","format":"uuid","description":"ID of the Terminal49 template this definition was copied from.","uniqueKey":"data.items.[INDEX].attributes.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"ID of the Terminal49 template this definition was copied from.","uniqueKey":"data.items.[INDEX].attributes.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].attributes.template_id","typeLabel":"string\u003cuuid> | null"},"has_data":{"type":"boolean","description":"Whether any entity has a value for this definition.","uniqueKey":"data.items.[INDEX].attributes.has_data","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].attributes.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].attributes.updated_at","typeLabel":"string\u003cdate-time>"},"discarded_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the definition was archived.","uniqueKey":"data.items.[INDEX].attributes.discarded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the definition was archived.","uniqueKey":"data.items.[INDEX].attributes.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].attributes.discarded_at","typeLabel":"string\u003cdate-time> | null"}},"required":["entity_type","api_slug","display_name","data_type"],"uniqueKey":"data.items.[INDEX].attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"account":{"type":"object","description":"The owning account. `null` for Terminal49 templates.","properties":{"data":{"oneOf":[{"type":"object","required":["type","id"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].relationships.account.data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["account"],"isRequired":true,"uniqueKey":"data.items.[INDEX].relationships.account.data.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].relationships.account.data.oneOf.0","typeLabel":"object"},{"type":"null","required":["type","id"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["account"]}},"uniqueKey":"data.items.[INDEX].relationships.account.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].relationships.account.data","typeLabel":"object | null"}},"uniqueKey":"data.items.[INDEX].relationships.account","typeLabel":"object"},"created_by":{"type":"object","description":"The user who created the definition.","properties":{"data":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"isRequired":true,"uniqueKey":"data.items.[INDEX].relationships.created_by.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].relationships.created_by.data.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"data.items.[INDEX].relationships.created_by.data.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string","format":"uuid"}},"required":["type","id"],"uniqueKey":"data.items.[INDEX].relationships.created_by.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].relationships.created_by.data","typeLabel":"object | null"}},"uniqueKey":"data.items.[INDEX].relationships.created_by","typeLabel":"object"},"options":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["type","id"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].relationships.options.data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["custom_field_option"],"isRequired":true,"uniqueKey":"data.items.[INDEX].relationships.options.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].relationships.options.data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].relationships.options.data","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].relationships.options","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].relationships","typeLabel":"object"}},"required":["id","type"],"uniqueKey":"data.items.[INDEX]","typeLabel":"Custom field definition · object"},"uniqueKey":"data","typeLabel":"Custom field definition · object[]"},"links":{"title":"links","type":"object","properties":{"self":{"type":"string","uniqueKey":"links.self","typeLabel":"string"},"current":{"type":"string","uniqueKey":"links.current","typeLabel":"string"},"first":{"type":"string","uniqueKey":"links.first","typeLabel":"string"},"prev":{"type":"string","uniqueKey":"links.prev","typeLabel":"string"},"next":{"type":"string","uniqueKey":"links.next","typeLabel":"string"},"last":{"type":"string","uniqueKey":"links.last","typeLabel":"string"}},"description":"Pagination links. Each value is an absolute URL. `self` repeats the request URL as sent, including its query string and its encoding. `current`, `first`, `prev`, `next`, and `last` repeat the request's query parameters, with `page[number]` and `page[size]` in unencoded brackets.","uniqueKey":"links","typeLabel":"links · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"custom_field_definition","attributes":{"entity_type":"Shipment","api_slug":"\u003cstring>","display_name":"\u003cstring>","data_type":"short_text","description":"\u003cstring>","reference_type":"\u003cstring>","validation":{},"default_format":"\u003cstring>","default_value":"\u003cstring>","reference_number":true,"sensitive":true,"inline_option_creation":true,"template_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","has_data":true,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","discarded_at":"2023-11-07T05:31:56Z"},"relationships":{"account":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"account"}},"created_by":{"data":{"type":"user","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}},"options":{"data":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"custom_field_option"}]}}}],"links":{"self":"\u003cstring>","current":"\u003cstring>","first":"\u003cstring>","prev":"\u003cstring>","next":"\u003cstring>","last":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fa4ae7e9-ba7b-4434-9ac4-ccb8f8dc0459":{"authorization":{"name":"Authorization","type":"apiKey","in":"header","description":"Use a Terminal49 API key in the `Authorization` header with the `Token` prefix.\n\n`Authorization: Token YOUR_API_KEY`","scopes":[],"schemeName":"authorization"}}},"servers":{"716b8bce-f12c-4964-b0ac-d1c057abd32a":{"url":"https://api.terminal49.com/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"name":"Authorization","type":"apiKey","in":"header","description":"Use a Terminal49 API key in the `Authorization` header with the `Token` prefix.\n\n`Authorization: Token YOUR_API_KEY`","scopes":[],"schemeName":"authorization"},"schema":{"title":"Authorization","type":"string","description":"Use a Terminal49 API key in the `Authorization` header with the `Token` prefix.\n\n`Authorization: Token YOUR_API_KEY`","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"openapi.json"},"subdomain":"terminal49","siteName":"Terminal49","title":"List Custom Field Definition Templates | Terminal49 API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-17T06:22:33.783Z","originalFileLocation":"api-docs/api-reference/custom-fields/list-custom-field-definitions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Terminal49\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Custom Field Definition Templates | Terminal49 API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"List the Terminal49 custom field definition templates. Copy a template into your account with the template_id attribute of the account create route.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Terminal49 Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://terminal49.mintlify.site/docs/_mintlify/api/og/v2?division=Custom+Field+Definitions\u0026amp;title=List+custom+field+definition+templates\u0026amp;description=List+the+Terminal49+custom+field+definition+templates.+To+list+the+definitions+configured+for+your+account%2C+use+the+account-scoped+route.\u0026amp;theme=7be098b423a76a1dd960de64\u0026amp;signature=cf8847d089fd1dfd2994e3b9375165b521a0111bc698f6a57f5f2e89b0b1ec9e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Custom Field Definition Templates | Terminal49 API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List the Terminal49 custom field definition templates. Copy a template into your account with the template_id attribute of the account create route.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://terminal49.mintlify.site/docs/_mintlify/api/og/v2?division=Custom+Field+Definitions\u0026amp;title=List+custom+field+definition+templates\u0026amp;description=List+the+Terminal49+custom+field+definition+templates.+To+list+the+definitions+configured+for+your+account%2C+use+the+account-scoped+route.\u0026amp;theme=7be098b423a76a1dd960de64\u0026amp;signature=cf8847d089fd1dfd2994e3b9375165b521a0111bc698f6a57f5f2e89b0b1ec9e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/terminal49/_9u2Tikn6cczLICg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Terminal49\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A9E52\">\u003clink data-mint-head rel=\"canonical\" href=\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://terminal49.com/#organization\",\"name\":\"Terminal49\",\"url\":\"https://terminal49.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/terminal49/vf64v0nfd3Z9JQ4O/logos/light.svg?fit=max\u0026auto=format\u0026n=vf64v0nfd3Z9JQ4O\u0026q=85\u0026s=d4e213611d22dd79c263b9d1ffa46eea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://terminal49.com/docs#website\",\"name\":\"Terminal49\",\"url\":\"https://terminal49.com/docs\",\"publisher\":{\"@id\":\"https://terminal49.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions#webpage\",\"url\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions\",\"name\":\"List custom field definition templates\",\"description\":\"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.\",\"dateModified\":\"2026-10-17T06:22:33.783Z\",\"isPartOf\":{\"@id\":\"https://terminal49.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Custom Field Definitions\",\"item\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-account-custom-field-definitions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List custom field definition templates\",\"item\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions#apireference\",\"headline\":\"List custom field definition templates\",\"name\":\"List custom field definition templates\",\"description\":\"List the Terminal49 custom field definition templates. To list the definitions configured for your account, use the account-scoped route.\",\"url\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions\",\"mainEntityOfPage\":{\"@id\":\"https://terminal49.com/docs/api-docs/api-reference/custom-fields/list-custom-field-definitions#webpage\"},\"dateModified\":\"2026-10-17T06:22:33.783Z\",\"publisher\":{\"@id\":\"https://terminal49.com/#organization\"},\"isPartOf\":{\"@id\":\"https://terminal49.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Terminal49\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Terminal49","nav":{"global":{},"tabs":[{"tab":"Developer Guide","icon":"book","pages":[{"title":"Developer Guide","href":"/home"}]},{"tab":"API Reference","icon":"code","groups":[{"group":" ","pages":[{"title":"Terminal49 API Reference: Ocean Container Tracking","sidebarTitle":"Introduction","href":"/api-docs/api-reference/introduction"},{"title":"Shipment and container list filter reference","sidebarTitle":"List filters","href":"/api-docs/api-reference/list-filters"}]},{"group":"Tracking Requests","icon":"search","pages":[{"title":"List tracking requests","openapi":"get /tracking_requests","href":"/api-docs/api-reference/tracking-requests/list-tracking-requests"},{"title":"Create a tracking request","openapi":"post /tracking_requests","href":"/api-docs/api-reference/tracking-requests/create-a-tracking-request"},{"title":"Get a tracking request","openapi":"get /tracking_requests/{id}","href":"/api-docs/api-reference/tracking-requests/get-a-single-tracking-request"},{"title":"Edit a tracking request","openapi":"patch /tracking_requests/{id}","href":"/api-docs/api-reference/tracking-requests/edit-a-tracking-request"},{"title":"Cancel a tracking request","openapi":"patch /tracking_requests/{id}/cancel","href":"/api-docs/api-reference/tracking-requests/cancel-a-tracking-request"},{"title":"Infer Tracking Number (Beta)","sidebarTitle":"Infer Tracking Number 🆕","openapi":"post /tracking_requests/infer_number","href":"/api-docs/api-reference/tracking-requests/auto-detect-carrier"},{"title":"List tracking request custom fields","openapi":"get /tracking_requests/{tracking_request_id}/custom_fields","href":"/api-docs/api-reference/tracking-requests/list-tracking-request-custom-fields"},{"title":"Create tracking request custom field","openapi":"post /tracking_requests/{tracking_request_id}/custom_fields","href":"/api-docs/api-reference/tracking-requests/create-tracking-request-custom-field"},{"title":"Update tracking request custom field","openapi":"patch /tracking_requests/{tracking_request_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/tracking-requests/update-tracking-request-custom-field"},{"title":"Delete tracking request custom field","openapi":"delete /tracking_requests/{tracking_request_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/tracking-requests/delete-tracking-request-custom-field"}]},{"group":"Shipments","icon":"ship","pages":[{"title":"List shipments","openapi":"get /shipments","href":"/api-docs/api-reference/shipments/list-shipments"},{"title":"Get a shipment","openapi":"get /shipments/{id}","href":"/api-docs/api-reference/shipments/get-a-shipment"},{"title":"Edit a shipment","openapi":"patch /shipments/{id}","href":"/api-docs/api-reference/shipments/edit-a-shipment"},{"title":"List shipment custom fields","openapi":"get /shipments/{shipment_id}/custom_fields","href":"/api-docs/api-reference/shipments/list-shipment-custom-fields"},{"title":"Create shipment custom field","openapi":"post /shipments/{shipment_id}/custom_fields","href":"/api-docs/api-reference/shipments/create-shipment-custom-field"},{"title":"Update shipment custom field","openapi":"patch /shipments/{shipment_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/shipments/update-shipment-custom-field"},{"title":"Delete shipment custom field","openapi":"delete /shipments/{shipment_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/shipments/delete-shipment-custom-field"},{"title":"Stop tracking a shipment","openapi":"patch /shipments/{id}/stop_tracking","href":"/api-docs/api-reference/shipments/stop-tracking-shipment"},{"title":"Resume tracking a shipment","openapi":"patch /shipments/{id}/resume_tracking","href":"/api-docs/api-reference/shipments/resume-tracking-shipment"}]},{"group":"Containers","icon":"warehouse","pages":[{"title":"List containers","openapi":"get /containers","href":"/api-docs/api-reference/containers/list-containers"},{"title":"Edit a container","openapi":"patch /containers/{id}","href":"/api-docs/api-reference/containers/edit-a-container"},{"title":"Get a container","openapi":"get /containers/{id}","href":"/api-docs/api-reference/containers/get-a-container"},{"title":"List container custom fields","openapi":"get /containers/{container_id}/custom_fields","href":"/api-docs/api-reference/containers/list-container-custom-fields"},{"title":"Create container custom field","openapi":"post /containers/{container_id}/custom_fields","href":"/api-docs/api-reference/containers/create-container-custom-field"},{"title":"Update container custom field","openapi":"patch /containers/{container_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/containers/update-container-custom-field"},{"title":"Delete container custom field","openapi":"delete /containers/{container_id}/custom_fields/{api_slug}","href":"/api-docs/api-reference/containers/delete-container-custom-field"},{"title":"Refresh a container","openapi":"patch /containers/{id}/refresh","href":"/api-docs/api-reference/containers/refresh-container"},{"title":"Get container map GeoJSON","openapi":"get /containers/{id}/map_geojson","href":"/api-docs/api-reference/containers/get-container-map-geojson"},{"title":"Get a container's raw events","openapi":"get /containers/{id}/raw_events","href":"/api-docs/api-reference/containers/get-a-containers-raw-events"},{"title":"Get a container's transport events","openapi":"get /containers/{id}/transport_events","href":"/api-docs/api-reference/containers/get-a-containers-transport-events"}]},{"group":"Documents","icon":"file","pages":[{"title":"List documents","openapi":"get /documents","href":"/api-docs/api-reference/documents/list-documents"},{"title":"Upload a document","openapi":"post /documents","href":"/api-docs/api-reference/documents/upload-a-document"},{"title":"Get a document","openapi":"get /documents/{id}","href":"/api-docs/api-reference/documents/get-a-document"},{"title":"Edit a document","openapi":"patch /documents/{id}","href":"/api-docs/api-reference/documents/edit-a-document"},{"title":"Delete a document","openapi":"delete /documents/{id}","href":"/api-docs/api-reference/documents/delete-a-document"},{"title":"List document types","openapi":"get /documents/types","href":"/api-docs/api-reference/documents/list-document-types"},{"title":"Get a document download URL","openapi":"get /documents/{id}/download_url","href":"/api-docs/api-reference/documents/get-a-document-download-url"},{"title":"Re-extract a document","openapi":"post /documents/{id}/reextract","href":"/api-docs/api-reference/documents/re-extract-a-document"},{"title":"Re-classify a document","openapi":"post /documents/{id}/reclassify","href":"/api-docs/api-reference/documents/re-classify-a-document"},{"title":"Re-link a document","openapi":"post /documents/{id}/relink","href":"/api-docs/api-reference/documents/re-link-a-document"},{"title":"Rotate a document","openapi":"post /documents/{id}/rotate","href":"/api-docs/api-reference/documents/rotate-a-document"}]},{"group":"Email Submissions","icon":"envelope","pages":[{"title":"List email submissions","openapi":"get /email_submissions","href":"/api-docs/api-reference/email-submissions/list-email-submissions"},{"title":"Get an email submission","openapi":"get /email_submissions/{id}","href":"/api-docs/api-reference/email-submissions/get-an-email-submission"}]},{"group":"Document Schemas","icon":"brackets-curly","pages":[{"title":"Get a document schema","openapi":"get /document_schemas/{id}","href":"/api-docs/api-reference/document-schemas/get-a-document-schema"}]},{"group":"Document Representations","icon":"binary","pages":[{"title":"Document representations resource","href":"/api-docs/api-reference/document-representations/document-representations-resource"}]},{"group":"Search","icon":"magnifying-glass","pages":[{"title":"Search","openapi":"get /search","href":"/api-docs/api-reference/search/search"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Get a single webhook","openapi":"get /webhooks/{id}","href":"/api-docs/api-reference/webhooks/get-single-webhook"},{"title":"Delete a webhook","openapi":"delete /webhooks/{id}","href":"/api-docs/api-reference/webhooks/delete-a-webhook"},{"title":"Edit a webhook","openapi":"patch /webhooks/{id}","href":"/api-docs/api-reference/webhooks/edit-a-webhook"},{"title":"List webhooks","openapi":"get /webhooks","href":"/api-docs/api-reference/webhooks/list-webhooks"},{"title":"List webhook events","openapi":"get /webhooks/events","href":"/api-docs/api-reference/webhooks/list-webhook-events"},{"title":"Create a webhook","openapi":"post /webhooks","href":"/api-docs/api-reference/webhooks/create-a-webhook"},{"title":"Trigger a webhook test delivery","openapi":"post /webhooks/trigger","href":"/api-docs/api-reference/webhooks/trigger-a-webhook"},{"title":"List webhook IPs","openapi":"get /webhooks/ips","href":"/api-docs/api-reference/webhooks/list-webhook-ips"}]},{"group":"Webhook Notifications","icon":"bell","pages":[{"title":"Get a single webhook notification","openapi":"get /webhook_notifications/{id}","href":"/api-docs/api-reference/webhook-notifications/get-a-single-webhook-notification"},{"title":"List webhook notifications","openapi":"get /webhook_notifications","href":"/api-docs/api-reference/webhook-notifications/list-webhook-notifications"},{"title":"Get webhook notification payload examples","openapi":"get /webhook_notifications/examples","href":"/api-docs/api-reference/webhook-notifications/get-webhook-notification-payload-examples"}]},{"group":"Custom Field Definitions","pages":[{"title":"List account custom field definitions","openapi":"get /accounts/{account_id}/custom_field_definitions","href":"/api-docs/api-reference/custom-fields/list-account-custom-field-definitions"},{"title":"Create an account custom field definition","description":"Create a custom field definition on your Terminal49 account to attach structured metadata, like reference codes or enums, to shipments and containers.","openapi":"post /accounts/{account_id}/custom_field_definitions","href":"/api-docs/api-reference/custom-fields/create-account-custom-field-definition"},{"title":"List custom field definition templates","openapi":"get /custom_field_definitions","href":"/api-docs/api-reference/custom-fields/list-custom-field-definitions"},{"title":"Get a custom field definition","description":"Retrieve a single custom field definition from the Terminal49 API, including its data type, slug, target resource type, and configured enum options.","openapi":"get /custom_field_definitions/{id}","href":"/api-docs/api-reference/custom-fields/get-a-custom-field-definition"},{"title":"Create a custom field definition template","openapi":"post /custom_field_definitions","href":"/api-docs/api-reference/custom-fields/create-a-custom-field-definition"},{"title":"Update a custom field definition","openapi":"patch /custom_field_definitions/{id}","href":"/api-docs/api-reference/custom-fields/update-a-custom-field-definition"},{"title":"Delete a custom field definition","openapi":"delete /custom_field_definitions/{id}","href":"/api-docs/api-reference/custom-fields/delete-a-custom-field-definition"}]},{"group":"Custom Field Options","pages":[{"title":"List custom field options","openapi":"get /custom_field_definitions/{definition_id}/options","href":"/api-docs/api-reference/custom-fields/list-custom-field-options"},{"title":"Get a custom field option","openapi":"get /custom_field_definitions/{definition_id}/options/{option_id}","href":"/api-docs/api-reference/custom-fields/get-a-custom-field-option"},{"title":"Create a custom field option","openapi":"post /custom_field_definitions/{definition_id}/options","href":"/api-docs/api-reference/custom-fields/create-a-custom-field-option"},{"title":"Update a custom field option","openapi":"patch /custom_field_definitions/{definition_id}/options/{option_id}","href":"/api-docs/api-reference/custom-fields/update-a-custom-field-option"},{"title":"Delete a custom field option","openapi":"delete /custom_field_definitions/{definition_id}/options/{option_id}","href":"/api-docs/api-reference/custom-fields/delete-a-custom-field-option"}]},{"group":"Custom Fields","pages":[{"title":"List custom fields","openapi":"get /custom_fields","href":"/api-docs/api-reference/custom-fields/list-custom-fields"},{"title":"Get a custom field","openapi":"get /custom_fields/{id}","href":"/api-docs/api-reference/custom-fields/get-a-custom-field"},{"title":"Create a custom field","openapi":"post /custom_fields","href":"/api-docs/api-reference/custom-fields/create-a-custom-field"},{"title":"Update a custom field","openapi":"patch /custom_fields/{id}","href":"/api-docs/api-reference/custom-fields/update-a-custom-field"},{"title":"Delete a custom field","openapi":"delete /custom_fields/{id}","href":"/api-docs/api-reference/custom-fields/delete-a-custom-field"}]},{"group":"Account","icon":"id-badge","pages":[{"title":"Get the current credential","openapi":"get /me","href":"/api-docs/api-reference/account/get-the-current-credential"}]},{"group":"Trade Intelligence","icon":"chart-line","pages":[{"title":"Get trade intelligence coverage","openapi":"get /trade_intel/meta","href":"/api-docs/api-reference/trade-intelligence/get-trade-intelligence-coverage"},{"title":"Search importers","openapi":"post /trade_intel/companies/search","href":"/api-docs/api-reference/trade-intelligence/search-importers"},{"title":"Get an importer profile","openapi":"post /trade_intel/companies/profile","href":"/api-docs/api-reference/trade-intelligence/get-an-importer-profile"},{"title":"Search commodities","openapi":"post /trade_intel/commodities/search","href":"/api-docs/api-reference/trade-intelligence/search-commodities"},{"title":"Rank importers","openapi":"post /trade_intel/importers/top","href":"/api-docs/api-reference/trade-intelligence/rank-importers"},{"title":"Get import trends","openapi":"post /trade_intel/trends","href":"/api-docs/api-reference/trade-intelligence/get-import-trends"},{"title":"Get an import breakdown","openapi":"post /trade_intel/breakdown","href":"/api-docs/api-reference/trade-intelligence/get-an-import-breakdown"},{"title":"Look up a container's import record","openapi":"post /trade_intel/containers/lookup","href":"/api-docs/api-reference/trade-intelligence/look-up-a-containers-import-record"},{"title":"Look up a bill of lading","openapi":"post /trade_intel/bills_of_lading/lookup","href":"/api-docs/api-reference/trade-intelligence/look-up-a-bill-of-lading"}]},{"group":"Shipping Lines","icon":"ship","pages":[{"title":"List shipping lines","openapi":"get /shipping_lines","href":"/api-docs/api-reference/shipping-lines/shipping-lines"},{"title":"Get a single shipping line","openapi":"get /shipping_lines/{id}","href":"/api-docs/api-reference/shipping-lines/get-a-single-shipping-line"}]},{"group":"Metro Areas","icon":"map-pin","pages":[{"title":"Get a metro area","openapi":"get /metro_areas/{id}","href":"/api-docs/api-reference/metro-areas/get-a-metro-area-using-the-unlocode-or-the-id"}]},{"group":"Ports","icon":"anchor","pages":[{"title":"Get a port","openapi":"get /ports/{id}","href":"/api-docs/api-reference/ports/get-a-port-using-the-locode-or-the-id"}]},{"group":"Vessels","icon":"sailboat","pages":[{"title":"Get a vessel by ID","openapi":"get /vessels/{id}","href":"/api-docs/api-reference/vessels/get-a-vessel-using-the-id"},{"title":"Get a vessel by IMO","openapi":"get /vessels/{imo}","href":"/api-docs/api-reference/vessels/get-a-vessel-using-the-imo"},{"title":"Get vessel future positions","openapi":"get /vessels/{id}/future_positions","href":"/api-docs/api-reference/vessels/get-vessel-future-positions"},{"title":"Get vessel future positions from coordinates","openapi":"get /vessels/{id}/future_positions_with_coordinates","href":"/api-docs/api-reference/vessels/get-vessel-future-positions-with-coordinates"}]},{"group":"Terminals","icon":"warehouse","pages":[{"title":"Get a terminal","openapi":"get /terminals/{id}","href":"/api-docs/api-reference/terminals/get-a-terminal-using-the-id"}]},{"group":"Parties","icon":"users","pages":[{"title":"List parties","openapi":"get /parties","href":"/api-docs/api-reference/parties/list-parties"},{"title":"Create a party","openapi":"post /parties","href":"/api-docs/api-reference/parties/create-a-party"},{"title":"Get a party","openapi":"get /parties/{id}","href":"/api-docs/api-reference/parties/get-a-party"},{"title":"Edit a party","openapi":"patch /parties/{id}","href":"/api-docs/api-reference/parties/edit-a-party"}]},{"group":"Party Roles","icon":"user-tag","pages":[{"title":"List shipment party roles","openapi":"get /shipments/{shipment_id}/party_roles","href":"/api-docs/api-reference/party-roles/list-shipment-party-roles"},{"title":"Assign a shipment party role","openapi":"post /shipments/{shipment_id}/party_roles","href":"/api-docs/api-reference/party-roles/assign-a-shipment-party-role"},{"title":"Remove a shipment party role","openapi":"delete /shipments/{shipment_id}/party_roles/{id}","href":"/api-docs/api-reference/party-roles/remove-a-shipment-party-role"},{"title":"List container party roles","openapi":"get /containers/{container_id}/party_roles","href":"/api-docs/api-reference/party-roles/list-container-party-roles"},{"title":"Assign a container party role","openapi":"post /containers/{container_id}/party_roles","href":"/api-docs/api-reference/party-roles/assign-a-container-party-role"},{"title":"Remove a container party role","openapi":"delete /containers/{container_id}/party_roles/{id}","href":"/api-docs/api-reference/party-roles/remove-a-container-party-role"}]}]},{"tab":"Data Coverage","icon":"globe","pages":[{"title":"Data Coverage","href":"/coverage/home"}]},{"tab":"Migrate to T49","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate to T49","href":"/migrate/home"}]},{"tab":"SDK Docs","icon":"rectangle-terminal","pages":[{"title":"SDK Docs","href":"/sdk/introduction"}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp/home"}]},{"tab":"DataSync","icon":"database","pages":[{"title":"DataSync","href":"/datasync/home"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/updates/home"}]}]},"basePath":"","title":"List Custom Field Definition Templates | Terminal49 API Documentation","buildId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","deploymentId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_7my4bd.js","utils-Cq_itTNA.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B5KPEvGz.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DBX-JepP.js","snippetPresets-Bsspz-Ge.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-jcs-2nGf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dp53in7F.js","shallow-Dv9eUdUd.js","getApiPlaygroundDisplay-D8cDwNhi.js","CodeSnippet-DkwXLQor.js","CodeSnippets-DcSgKqs5.js","Page-t8ynOKTD.js","getPastedJson-I2RjoApV.js","icon-BIj57rZC.js","MethodPill-CTwLPWXC.js","DuplicateIcon-BJpFwygY.js","createIcon-C7PorfAe.js","DynamicMarkdown-BBht_uEs.js","SectionHeading-YIBwxbzj.js","axios-vUo_bRtp.js","Markdown--YCeFtOs.js","clsx-CrPa459s.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BWxsj3I0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fBzVvq7k.js"]}