API ReferenceCustom
Back to Platform

GET /custom/fields/{id}

GET
/custom/fields/{id}

GET operation for /custom/fields/{id}

Authorization

ApiKeyAuth
Authorization<token>

API key authentication. Format: Your API key (no "Token" prefix needed)

In: header

Path Parameters

id*string

Response Body

application/json

curl -X GET "https://dev-rest.onboard.io/custom/fields/string"
{
  "id": 1,
  "label": "string",
  "api_name": "string",
  "description": "string",
  "object": "customer",
  "type": "number",
  "options": {},
  "is_internal": true,
  "is_active": true,
  "created_at": "2021-01-01T00:00:00Z",
  "tables_display_enabled": true,
  "panels_display_enabled": true,
  "outboard_display_enabled": true,
  "map_types": "string"
}
Empty
Empty
Empty

How is this guide?

POST /custom/fields POST

POST operation for /custom/fields

PATCH /custom/fields/{id} PATCH

PATCH operation for /custom/fields/{id}