pipefyUts 1.2.1

Pipefy manipulator

PipefyUts

Installation

pip install pipefyUts

Dependencies

This package requires the following dependencies:

• requests
• python-dateutil

These are automatically installed when you install pipefyUts via pip.

GitHub

https://github.com/ZdekPyPi/PipefyUts

Usage

Auth

python code

from pipefyUts import Pipefy

ORG_ID =  "<your_org_id>"
TOKEN  = "<your_token>"

pfy = Pipefy(ORG_ID,TOKEN)

listMembers

pfy.listMembers()

output

[
    {"id":1,"name":"name_1","email":"[e-mail]"},
    {"id":2,"name":"name_2","email":"[e-mail]"},
    {"id":3,"name":"name_3","email":"[e-mail]"},
    {"id":4,"name":"name_4","email":"[e-mail]"}
]

listStartFormFields

pfy.listStartFormFields(pipe_id="<pipe_id>")

output

[
    {"id":"field_1","label":"field_label_1"},
    {"id":"field_2","label":"field_label_2"},
    {"id":"field_3","label":"field_label_3"},
    {"id":"field_4","label":"field_label_4"}
]

listCardsFromPhase

pfy.listCardsFromPhase(phase_id="<phase_id>")

output

[
    {"id":"card_id_1","fields":[{...},{...},{...},...]},
    {"id":"card_id_2","fields":[{...},{...},{...},...]},
    {"id":"card_id_3","fields":[{...},{...},{...},...]},
    {"id":"card_id_4","fields":[{...},{...},{...},...]}
]

createAttachment

path = pfy.createAttachment(file_path="<my_file>")

output

"orgs/123456-1234-1234-1234-123asd5as1ad5s1/uploads/123ad3-123ddas-123cs-123da-asdc21cas21/my_file.txt"

cardCreation

authentication first

from pipefyUts import Pipefy,NewCard,CardField

ORG_ID =  "<your_org_id>"
TOKEN  = "<your_token>"

pfy = Pipefy(ORG_ID,TOKEN)

create card schema

class MyCard(NewCard):
    #DEFAULT
    __pipeid__               = "<my_pipe_id>"
    __title__                = "<card_title>"

    #PIPEFY FIELDS
    description              = CardField(str)
    total_ammount            = CardField(float)
    owners                   = CardField(list)
    files                    = CardField(list,is_file_path=True)

create card

#CREATE CARD OBJECT
myNewCard = MyCard(
    description   = "AdtPro",
    total_ammount = 123.46,
    owners        = ["<owner_id>"],
    files         = [r".\Doc1.pdf",r".\Doc2.txt"]
)

#RUN CARD CREATION
pfy.createCard(card=myNewCard)

output

{"id":"card_id"}

Card Manipulation

Get a Card

card = pfy.getCard(card_id="<card_id>")

Move Card to Phase

card.move(phase_id="<phase_id>")

Delete Card

card.delete()

Get Card Fields

fields = card.fields()

output

{"field_id_1": "value1", "field_id_2": "value2", ...}

Update Field Value

card.updateFieldValue(field_id="<field_id>", value="<new_value>")

Add Labels

card.addLabels(label_ids=["<label_id1>", "<label_id2>"])

Remove Labels

card.removeLabels(label_ids=["<label_id1>", "<label_id2>"])

Remove All Labels

card.removeAllLabels()

Get Comments

comments = card.comments()

Add Comment

comment = card.newComment(text="<comment_text>")

Get Labels

labels = card.labels()

Change Log

1.1.7 (2026-04-07)

• Fixed circular import issue between models.py and card.py
• Added python-dateutil as a dependency
• Removed unused import from typing_extensions

1.0.9 (2024-07-25)

• File spaces upload adjustment

1.0.0 (2024-04-26)

• First Release