GetPhase

Official API
Implemented Class

Gets detailed information on a Phase.

Arguments

<In> PhaseID : long

ID of the Phase to be obtained.

You can find this info from the API or from the link when accessing it through the web.

<Out> Phase : JObject

The phase obtained (JObject).

Example object:

{
    "cards_can_be_moved_to_phases": [
        {
            "done": false,
            "id": "1234565",
            "name": "Inbox"
        },
        {
            "done": true,
            "id": "1234567",
            "name": "Done"
        }
    ],
    "cards_count": 8,
    "description": "This is a nice phase. Right in the middle of the pipe.",
    "done": false,
    "expiredCardsCount": 0,
    "fields": [{
        "description": "A simple information field for some codes",
        "id": "simple_information",
        "is_multiple": false,
        "label": "Simple information",
        "required": false,
        "type": "short_text"
    }],
    "id": "12345678",
    "lateCardsCount": 2,
    "name": "Doing"
}

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.

All actions