Get Custom Fields
Custom fields are user-defined fields that let you capture additional information tailored to your organization’s specific needs. They can be added to bookings, projects, resources, contacts, quotes, and invoices, offering the flexibility to store and manage data not covered by the default fields.
Custom fields can be configured with three input types: single-line text, multi-line text, and dropdown select menus with predefined options.
For example, you could use custom fields to track additional producers, links to files in external systems, internal notes, or client preferences.
READ
access to the ADMIN
module is required to access this endpointAuthorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
One or more (comma seperated) IDs of custom fields to retrieve.
Perform a partial match text search for the custom field name
Perform a partial match text search for the custom field description
Specify the type of custom field you wish to return
text
, textarea
, select
Specify the module you wish to get custom fields for
booking
, project
, people
, organization
, quote
, invoice
, quote_invoice
, billable_item
Return fields marked as required
Comma seperated list of fields you wish to return
Specify the page of results you wish to return
The number of results returned per page. Default if not specified is 10
Specify the field (with type of string or integer) you wish to order (ascending) the response with
Specify the field (with type of string or integer) you wish to order (descending) the response with
Specify if multiple filters should be combined with OR or AND logic
OR
, AND