# Pipefy

> Manage cards, phases, comments and database records using Pipefy GraphQL.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/pipefy

## Actions

### Create card

Creates a card in a pipe with a title and optional field values, due date, assignees and labels. Returns the new card's ID.

**Inputs**

- Pipe (`pipe_id`, text, required): Pipe ID.
- Title (`title`, text, required): Title.
- Fields (`fields`, object): Fields.
- Due date (`due_date`, date and time): Due date.
- Assignee IDs (`assignee_ids`, list): Assignee IDs.
- Label IDs (`label_ids`, list): Label IDs.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### Create comment

Adds a text comment to a card by its card ID. Returns the new comment's ID.

**Inputs**

- Card ID (`card_id`, text, required): Card ID.
- Text (`text`, text, required): Text.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": "example",
    "text": "example"
  }
}
```

### Create table record

Creates a record in a database table with a title and optional field values and due date. Returns the new record's ID.

**Inputs**

- Table ID (`table_id`, text, required): Table ID.
- Title (`title`, text, required): Title.
- Fields (`fields`, object): Fields.
- Due date (`due_date`, date and time): Due date.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### Delete card

Deletes a card from its pipe by its card ID. Returns whether it succeeded.

**Inputs**

- Card ID (`card_id`, text, required): Card ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Delete comment

Deletes a comment from a card by its comment ID. Returns whether it succeeded.

**Inputs**

- Comment ID (`comment_id`, text, required): Comment ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Delete table record

Deletes a table record by its record ID. Returns whether it succeeded.

**Inputs**

- Record ID (`record_id`, text, required): Record ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "success": false
  }
}
```

### Get card

Gets one card by its card ID, including its title, phase, field values, assignees, labels and due date.

**Inputs**

- Card ID (`card_id`, text, required): Card ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### Get current user

Gets the connected Pipefy user's ID, name and email.

**Inputs**: None.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "email": "example",
    "id": "example",
    "name": "example"
  }
}
```

### Get organization

Gets one organization by its ID, including its name and the pipes and tables in it.

**Inputs**

- Organization (`organization_id`, text, required): Organization ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example",
    "pipes": [],
    "tables": {
      "edges": []
    }
  }
}
```

### Get pipe

Gets one pipe by its pipe ID, including its phases, fields and labels, which you need to create and move cards.

**Inputs**

- Pipe (`pipe_id`, text, required): Pipe ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": "example",
    "labels": [],
    "name": "example",
    "phases": [],
    "start_form_fields": [],
    "users": []
  }
}
```

### Get table

Gets one database table by its table ID, including its name and fields.

**Inputs**

- Table ID (`table_id`, text, required): Table ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example",
    "table_fields": []
  }
}
```

### Get table record

Gets one table record by its record ID, including its title, field values and due date.

**Inputs**

- Record ID (`record_id`, text, required): Record ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### List cards

Lists the cards in a pipe by its pipe ID, with each card's ID, title, current phase and due date. Returns one page; use the paging fields for the next page.

**Inputs**

- Pipe (`pipe_id`, text, required): Pipe ID.
- First (`first`, number): First. From 1 to 50.
- After (`after`, text): After.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "items": [],
    "page_info": {
      "endCursor": "example",
      "hasNextPage": false
    }
  }
}
```

### List organizations

Lists the Pipefy organizations the connected user belongs to, with each organization's ID and name.

**Inputs**: None.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List table records

Lists the records in a database table by its table ID, with each record's ID, title and field values. Returns one page; use the paging fields for the next page.

**Inputs**

- Table ID (`table_id`, text, required): Table ID.
- First (`first`, number): First. From 1 to 50.
- After (`after`, text): After.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "items": [],
    "page_info": {
      "endCursor": "example",
      "hasNextPage": false
    }
  }
}
```

### Move card

Moves a card to another phase of its pipe, by card ID and phase ID.

**Inputs**

- Pipe (`pipe_id`, text, required): The pipe containing this card.
- Card ID (`card_id`, text, required): Card ID.
- Phase (`phase_id`, text, required): Phase ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### Update card

Changes a card's title, due date, assignees or labels, by its card ID.

**Inputs**

- Card ID (`card_id`, text, required): Card ID.
- Title (`title`, text): Title.
- Due date (`due_date`, date and time): Due date.
- Assignee IDs (`assignee_ids`, list): Assignee IDs.
- Label IDs (`label_ids`, list): Label IDs.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### Update card field

Sets the value of one field on a card, by card ID and field ID.

**Inputs**

- Card ID (`card_id`, text, required): Card ID.
- Field ID (`field_id`, text, required): Field ID.
- New value (`new_value`, list, required): New value.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```

### Update comment

Replaces the text of a comment by its comment ID.

**Inputs**

- Comment ID (`comment_id`, text, required): Comment ID.
- Text (`text`, text, required): Text.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "id": "example",
    "text": "example"
  }
}
```

### Update table record

Changes a table record's title or due date, by its record ID.

**Inputs**

- Record ID (`record_id`, text, required): Record ID.
- Title (`title`, text): Title.
- Due date (`due_date`, date and time): Due date.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}
```
