GetPipe
Official API
Implemented Class
Gets detailed information about a Pipe.
Arguments
<In> PipeID : string
ID of the Pipe to be obtained.
You can find this info from the API or from the link when accessing it through the web.
<Out> Pipe : JObject
The Pipe obtained (JObject).
Example object:
{
"anyone_can_create_card": true,
"cards_count": 41,
"description": "The description of this pipe.",
"id": "123456",
"labels": [
{
"id": "1234567",
"name": "Label name"
}
],
"name": "My Pipe",
"opened_cards_count": 13,
"phases": [
{
"cards_count": 7,
"done": false,
"id": "1234565",
"name": "Inbox"
},
{
"cards_count": 6,
"done": false,
"id": "1234566",
"name": "Doing"
},
{
"cards_count": 28,
"done": true,
"id": "1234567",
"name": "Done"
}
],
"public": true,
"title_field": {
"id": "simple_information"
}
}
Inherited Arguments
<In> Bearer : string
The Bearer authorization token generated by Pipefy.
<In> Timeout : int
The timeout limit (in ms) for the request to be completed.
<Out> Status : string
A brief status message of the result of the action.
<Out> Success : boolean
True if the action was successful.