Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

LeadTypes.get

Returns leadtype with given id

Input

type: object properties: parameters: type: object properties: id: type: string format: uuid description: ID of leadtype to retrieve required: - id title: Parameters

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: required: - id - lead_process - form_lost_enabled - is_readonly - lead_process_id - name - has_draft - is_delete_protected - form_edit_api - form_lost_api properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Creation time. readOnly: true lead_process: type: string format: uri description: >- Relation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties. form_edit: type: object description: Form definition in json format. form_lost: type: object description: Form definition in json format. form_lost_enabled: type: boolean example: false description: Boolean value. is_readonly: type: boolean example: false description: Boolean value. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. name: type: string example: string description: Name of the entity and its default text representation. is_published: type: boolean example: false description: '' readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published is_delete_protected: type: boolean example: false description: >- Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true form_edit_api: type: object description: Form definition in json format. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. form_lost_api: type: object description: Form definition in json format. type: object