Skip to main content
GET
/
fields
Get CustomFields
curl --request GET \
  --url https://public.watermelon.ai/api/v1/fields \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "company_id": 123,
    "icon": "information",
    "name": "Order number",
    "type": "text",
    "order": 123,
    "value": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "is_unique": true
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

Custom fields retrieved

​
id
integer
Example:

1

​
company_id
integer
​
icon
string
Example:

"information"

​
name
string
Example:

"Order number"

​
type
enum<string>
Available options:
text,
short_text,
numbers,
phone,
email,
currency,
date
Example:

"text"

​
order
integer
​
value
string
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time>
​
is_unique
boolean