Retrieve custom fields list

GET /custom-fields

Retrieve custom fields list

cURL

curl --request GET \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields \
  --header 'x-api-key: <api-key>'

import requests

url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

401

{
  "message": "Unauthorized"
}

{
  "message": "Request URL not found"
}

{
  "message": "Internal Server Error"
}

Authorizations

x-api-key · string · header · required

Query Parameters

limit · string

Defaults to 20 items per page, maximum 100 items allowed.

object_type · string

Allowed values: customer, job, invoice, item, maintenance_agreement, project, asset, material_list.

page · string

Page number. Starts from 1, defaults to 1.

calculate_count · string

true or false. If true, in response will be included also total count

filter · string

Array of attribute, operator, and value parts.

sort · string

Array of attribute and order values.

rel · string

array consisting of indices with the desired relation to include

Response

200

application/json

Successful response