CompanyCustomFields
List the options of a custom field
Returns a paginated list of the options of this custom field, ordered by value.
- Customer: without customer_id, every option of the field, common and of every customer. With it, the common options and those of that customer.
- Archived: archived options are left out unless include_archived=true.
- Suggestions off: the options of a field with suggest_values: false are listed too. They are not offered on invoices while the setting is off.
get/v1/companies/{company_id}/custom-fields/{key}/options
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/companies/{company_id}/custom-fields/{key}/options
- Auth: HTTP bearer
Query parameters
pageinteger
Page number, starting at 1. The response echoes it back as pagination.current_page.
limitinteger
How many items to return per page. The response echoes it back as pagination.items_per_page.
customer_idstring uuid
Limits the list to the common options and those of this customer. 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
Options of the custom field.
Example response
{
"success": true,
"data": {
"options": [
{
"id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",
"value": "Gran Vía 12",
"customer_id": "4f244735-980b-4d9c-80e8-6331fa0b1958"
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 87,
"items_per_page": 20
}
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.