Pipelines

List pipeline fields

Changed on

The fields of one pipeline, in column order. A field's source says where its value lives: ENTRY fields are stored on the entry — their fieldIds are the keys entry values accept — while RECORD fields read (and write through to) an attribute of the company or contact and arrive on entries as recordValues. type, unit and calculation say how to render a value and what the stage footers total.

get/pipelines/{pipelineId}/properties

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/pipelines/{pipelineId}/properties
  • Auth
    HTTP bearer

Path parameters

pipelineIdstring required

Headers

projectstring required

Response

Ok

propertyIdstring required
fieldIdstring required
labelstring required
type'TEXT' | 'NUMBER' | 'BOOLEAN' | 'EMAIL' | 'DATE' | 'TIME' | 'TEXTAREA' | 'RICHTEXT' | 'SELECT' | 'MULTISELECT' | 'UPLOAD' | 'PHONE' required

What a property stores. The values are the persisted DB strings and are mirrored by the dashboard's PropertyType — never rename a member, only add.

Its own decorator-free module so pure services (and their harnesses) can import the enum without loading the Mongoose model.

source'ENTRY' | 'RECORD' required

Where a field's value lives.

ordernumber double required
widthnumber double
unitstring
calculation'sum' | 'average' | 'min' | 'max'

Footer totals the lane-stats aggregation supports. Numbers only.

recordPathstring

RECORD only: dotted path on the company/session document (value, customData.seats).

readOnlyboolean

RECORD only: the attribute cannot be written (e.g. last-seen device type).

Changes

  • 490b7d6391f3Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed subschema #1 subschema #2 subschema #4 from the response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • fe2dff9fb04bRevision changes
    • info

      endpoint added