CompanyCustomFields
Get a custom field of a company
Returns one custom field of this company, archived or not, with the options that apply to the query: the common ones plus, with customer_id, those of that customer. Archived options are left out unless include_archived=true. A field with suggest_values: false carries no options; list them with GET /v1/companies/{company_id}/custom-fields/{key}/options.
get/v1/companies/{company_id}/custom-fields/{key}
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/companies/{company_id}/custom-fields/{key}
- Auth: HTTP bearer
Query parameters
customer_idstring uuid
Adds the options of this customer to the common ones. A value that names no customer of this company is not an error: only the common options come back.
include_archivedboolean
Include archived options.
Response
The custom field.
Example response
{
"success": true,
"data": {
"id": "7d2f8a40-3c1e-4b6a-9f0d-2e5b8c1a4d77",
"key": "store",
"label": "Store",
"show_on_pdf": true,
"suggest_values": true,
"is_archived": false,
"options": [
{
"id": "0b6c1e2f-5a4d-4c3b-8e7f-1a2b3c4d5e6f",
"value": "Online store",
"customer_id": null,
"is_archived": false
},
{
"id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",
"value": "Gran Vía 12",
"customer_id": "4f244735-980b-4d9c-80e8-6331fa0b1958",
"is_archived": false
}
]
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.