Custom Fields

Define and manage custom fields for clients, products, and documents. Set values per entity.

Use cases: Use custom fields to extend entities with business-specific data like loyalty tiers, internal codes, or compliance flags.

GET/custom-fields

List all custom field definitions.

Request

curl -X GET "https://api.glance.co.il/custom-fields" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "data": [
    {
      "id": 1,
      "label": "Loyalty Tier",
      "entityType": "client",
      "fieldType": "select",
      "options": [
        "Bronze",
        "Silver",
        "Gold",
        "Platinum"
      ],
      "required": false
    },
    {
      "id": 2,
      "label": "Weight (kg)",
      "entityType": "product",
      "fieldType": "number",
      "required": true
    }
  ]
}

GET/custom-fields/type/:entityType

Get custom fields for a specific entity type.

Path Parameters

Name	Type		Description
`entityType`	string	required	Entity type: "client", "product", or "document".

Request

curl -X GET "https://api.glance.co.il/custom-fields/type/:entityType" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "data": [
    {
      "id": 1,
      "label": "Loyalty Tier",
      "entityType": "client",
      "fieldType": "select",
      "options": [
        "Bronze",
        "Silver",
        "Gold",
        "Platinum"
      ],
      "required": false
    }
  ]
}

POST/custom-fields/create

Create a new custom field definition.

Body Parameters

Name	Type		Description
`label`	string	required	Field label / display name.
`entityType`	string	required	Entity type: "client", "product", or "document".
`fieldType`	string	required	Field type: "text", "number", "date", "select", or "boolean".
`options`	string[]		Options for "select" type fields.
`required`	boolean		Whether this field is required (default false).

Request

curl -X POST "https://api.glance.co.il/custom-fields/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "example_label",
  "entityType": "example_entityType",
  "fieldType": "example_fieldType",
  "options": "example_options",
  "required": true
}'

Response

{
  "data": {
    "id": 5,
    "label": "Department",
    "entityType": "client",
    "fieldType": "select",
    "options": [
      "Sales",
      "Engineering",
      "Marketing"
    ],
    "required": false
  }
}

PUT/custom-fields/edit/:id

Update a custom field definition.

Path Parameters

Name	Type		Description
`id`	number	required	The custom field ID.

Body Parameters

Name	Type	Description
`label`	string	Field label.
`entityType`	string	Entity type.
`fieldType`	string	Field type.
`options`	string[]	Options for select fields.
`required`	boolean	Required flag.

Request

curl -X PUT "https://api.glance.co.il/custom-fields/edit/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "example_label",
  "entityType": "example_entityType",
  "fieldType": "example_fieldType",
  "options": "example_options",
  "required": true
}'

Response

{
  "data": {
    "id": 5,
    "label": "Department (Updated)",
    "entityType": "client",
    "fieldType": "select",
    "options": [
      "Sales",
      "Engineering",
      "Marketing",
      "Support"
    ]
  }
}

DELETE/custom-fields/delete/:id

Delete a custom field definition and all its values.

Path Parameters

Name	Type		Description
`id`	number	required	The custom field ID.

Request

curl -X DELETE "https://api.glance.co.il/custom-fields/delete/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "data": {
    "success": true
  }
}

GET/custom-fields/products/:productId

Get custom field values for a specific product.

Path Parameters

Name	Type		Description
`productId`	number	required	The product ID.

Request

curl -X GET "https://api.glance.co.il/custom-fields/products/:productId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "data": [
    {
      "fieldId": 2,
      "label": "Weight (kg)",
      "value": "1.5"
    }
  ]
}

GET/custom-fields/entities/:entityId

Get custom field values for a specific entity.

Path Parameters

Name	Type		Description
`entityId`	number	required	The entity ID.

Request

curl -X GET "https://api.glance.co.il/custom-fields/entities/:entityId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "data": [
    {
      "fieldId": 1,
      "label": "Loyalty Tier",
      "value": "Gold"
    }
  ]
}

POST/custom-fields/products/:productId/values

Set custom field values for a product.

Path Parameters

Name	Type		Description
`productId`	number	required	The product ID.

Body Parameters

Name	Type		Description
`values`	object[]	required	Array of field value pairs.
`fieldId`	number		Custom field ID.
`value`	string		Field value.

Request

curl -X POST "https://api.glance.co.il/custom-fields/products/:productId/values" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "values": "example_values"
}'

Response

{
  "data": [
    {
      "fieldId": 2,
      "label": "Weight (kg)",
      "value": "2.0"
    }
  ]
}

POST/custom-fields/entities/:entityId/values

Set custom field values for an entity.

Path Parameters

Name	Type		Description
`entityId`	number	required	The entity ID.

Body Parameters

Name	Type		Description
`values`	object[]	required	Array of field value pairs.
`fieldId`	number		Custom field ID.
`value`	string		Field value.

Request

curl -X POST "https://api.glance.co.il/custom-fields/entities/:entityId/values" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "values": "example_values"
}'

Response

{
  "data": [
    {
      "fieldId": 1,
      "label": "Loyalty Tier",
      "value": "Platinum"
    }
  ]
}