GetTable

Official API
Implemented Class

Gets detailed information about a Table in Pipefy.

Arguments

<In> TableID : string

ID of the Table to be obtained.

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

<Out> Table : JObject

Table obtained (JObject).

Example object:

{
    "description": "A simple description for this table.",
    "id": "M4a7Dqr6",
    "name": "TableName",
    "public": true,
    "statuses": [
        {
            "id": "1234567",
            "name": "Active"
        },
        {
            "id": "1234568",
            "name": "Done"
        }
    ],
    "table_fields": [
        {
            "description": null,
            "id": "example_number",
            "internal_id": "12345678",
            "label": "Example Number",
            "required": true,
            "type": "number"
        },
        {
            "description": "One example description for this field",
            "id": "example_text",
            "internal_id": "12345679",
            "label": "Example Text",
            "required": false,
            "type": "short_text"
        }
    ],
    "table_records_count": 1,
    "title_field": {
        "id": "example_number",
        "internal_id": "12345678",
        "label": "Example Number",
        "type": "number"
    },
    "url": "http://app.pipefy.com/database_v2/tables/M4a7Dqr6-tablename"
}

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