GET
/
v2
/
custom-field
Get Custom Fields
curl --request GET \
  --url https://api.sonderplan.com/v2/custom-field \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 8942,
      "name": "Booking Type",
      "description": "Select the type of booking",
      "type": "select",
      "options": [
        {
          "id": "4934",
          "name": "Video Editing",
          "order": "2"
        }
      ],
      "module": "booking",
      "order": 3,
      "required": true,
      "update_key": "2_1_8942",
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<string>

One or more (comma seperated) IDs of custom fields to retrieve.

​
name
string

Perform a partial match text search for the custom field name

​
description
string

Perform a partial match text search for the custom field description

​
type
enum<string>

Specify the type of custom field you wish to return

Available options:
text,
textarea,
select
​
module
enum<string>

Specify the module you wish to get custom fields for

Available options:
booking,
project,
people,
organization,
quote,
invoice,
quote_invoice,
billable_item
​
required
boolean

Return fields marked as required

​
fields
string

Comma seperated list of fields you wish to return

​
page
integer

Specify the page of results you wish to return

​
limit
integer

The number of results returned per page. Default if not specified is 10

​
order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

​
order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

​
filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

Successful Operation

​
data
Custom Field Model · object[]
​
meta
object