{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Listing custom fields","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"listing-custom-fields","__idx":0},"children":["Listing custom fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The steps below explain how to find the custom fields that already exist for a company. This is useful when you need to obtain a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]}," for a field you did not create yourself or change the order in which those custom fields are presented."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Step"},"children":["Step"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/listcustomfieldv3"},"children":["List custom fields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/companies/{companyId}/custom-fields/list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List the custom fields that apply to a company, including the ones inherited from a parent level.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," retrieved from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/companyapi/companies/readcompany"},"children":["get company"]}," API.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameter requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyRole"]},", which sets the level the list is read at.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paginationParams"]},", which accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," (default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},") and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," (default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},"). You can optionally add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchText"]}," to filter by name, and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}," object that accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["definedAtList"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldIds"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tripUsageTypes"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paginationParams"]}," and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," array. Each entry carries the custom field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["definedAt"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parentInfos"]},", which identifies the parent level field that this field was inherited from.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Other APIs will use:"]}," the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the custom field you want to read or modify, which every other endpoint takes as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]}," path parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/readcustomfieldv3"},"children":["Get custom field"]}," (optional)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v3/companies/{companyId}/custom-fields/{customFieldId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve a single custom field.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]}," from Step 1.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," the custom field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeLocations"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["managementTags"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["respondOnlyOnceLevel"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," The arms are not included in this response. Use the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/listarms"},"children":["list arms"]}," endpoint to retrieve them."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/reordercustomfields"},"children":["Reorder custom fields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v3/companies/{companyId}/custom-fields/reorder"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change the order in which the custom fields are presented to the traveler at checkout.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["targetFieldId"]},", which is the custom field that the others are moved relative to, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["direction"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BEFORE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AFTER"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldIdsToMove"]},", an array of at least one custom field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," taken from Step 1.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," status code indicating the order was updated."]}]}]}]}]}]},"headings":[{"value":"Listing custom fields","id":"listing-custom-fields","depth":1}],"frontmatter":{"seo":{"title":"Listing custom fields"}},"lastModified":"2026-09-16T16:41:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/spotnana/custom_field_list_workflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}