# Freelancer

> Post and manage projects on Freelancer.com, search open projects, handle bids and milestone payments, and send messages.

App · 23 actions. Web page: https://docs.lodol.com/docs/integrations/freelancer

## Actions

### Act on a bid

Award, revoke, shortlist or hide a bid on your project, or accept, deny or retract your own bid.

**Inputs**

- Bid ID (`bid_id`, number, required): The bid's ID. At least 1.
- Action (`operation`, text, required): What to do. Award, revoke, shortlist, unshortlist, hide and unhide are for the project's owner; accept, deny and retract are for the bidder. One of: `accept`, `deny`, `retract`, `award`, `revoke`, `shortlist`, `unshortlist`, `hide`, `unhide`.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}
```

### Close a project

Close a project that is open for bids, so nobody can bid on it.

**Inputs**

- Project (`project_id`, number, required): The project. Choose one of your projects or enter its ID. At least 1.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}
```

### Create a milestone payment

Put money into a milestone payment for the freelancer you hired. The amount is taken from your Freelancer balance.

**Inputs**

- Project (`project_id`, number, required): The project the payment is for. At least 1.
- Freelancer ID (`freelancer_id`, number, required): The user ID of the freelancer you hired. At least 1.
- Amount (`amount`, number, required): The amount, in the project's currency. At least 0.01.
- Reason (`reason`, text): What the payment is for. One of: `partial_payment` (Partial payment), `full_payment` (Full payment), `task_description` (Task description), `other`. Default: `partial_payment`.
- Description (`description`, text): A note about the payment.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "amount": 1,
      "bid_id": 1,
      "bidder_id": 1,
      "currency": {
        "code": "example",
        "exchange_rate": 1,
        "id": 1,
        "name": "example",
        "sign": "example"
      },
      "description": "example",
      "project_id": 1,
      "project_owner_id": 1,
      "reason": "example",
      "status": "example",
      "time_created": 1,
      "transaction_id": 1
    },
    "status": "example"
  }
}
```

### Get a bid

Get one bid by its ID.

**Inputs**

- Bid ID (`bid_id`, number, required): The bid's ID. At least 1.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "amount": 1,
      "award_status": "example",
      "bidder_id": 1,
      "complete_status": "example",
      "description": "example",
      "frontend_bid_status": "example",
      "id": 1,
      "milestone_percentage": 1,
      "paid_status": "example",
      "period": 1,
      "project_id": 1,
      "project_owner_id": 1,
      "retracted": true,
      "time_submitted": 1
    },
    "status": "example"
  }
}
```

### Get a project

Get one project, with its full description and skills.

**Inputs**

- Project (`project_id`, number, required): The project. Choose one of your projects or enter its ID. At least 1.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "bid_stats": {
        "bid_avg": 1,
        "bid_count": 1
      },
      "budget": {
        "maximum": 1,
        "minimum": 1
      },
      "currency": {
        "code": "example",
        "exchange_rate": 1,
        "id": 1,
        "name": "example",
        "sign": "example"
      },
      "description": "example",
      "frontend_project_status": "example",
      "id": 1,
      "jobs": [
        {
          "id": 1,
          "name": "example"
        }
      ],
      "owner_id": 1,
      "preview_description": "example",
      "seo_url": "example",
      "status": "example",
      "sub_status": "example",
      "time_submitted": 1,
      "time_updated": 1,
      "title": "example",
      "type": "example"
    },
    "status": "example"
  }
}
```

### Get a user

Get a Freelancer user's public profile by their user ID.

**Inputs**

- User ID (`freelancer_user_id`, number, required): The user's ID. At least 1.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "avatar": "example",
      "display_name": "example",
      "id": 1,
      "limited_account": true,
      "primary_currency": {
        "code": "example",
        "exchange_rate": 1,
        "id": 1,
        "name": "example",
        "sign": "example"
      },
      "public_name": "example",
      "registration_date": 1,
      "role": "example",
      "username": "example"
    },
    "status": "example"
  }
}
```

### Get my profile

Get the Freelancer account this connection signs in as: its user ID, username and currency.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "avatar": "example",
      "display_name": "example",
      "id": 1,
      "limited_account": true,
      "primary_currency": {
        "code": "example",
        "exchange_rate": 1,
        "id": 1,
        "name": "example",
        "sign": "example"
      },
      "public_name": "example",
      "registration_date": 1,
      "role": "example",
      "username": "example"
    },
    "status": "example"
  }
}
```

### Invite a freelancer to bid

Invite a freelancer to bid on one of your projects.

**Inputs**

- Project (`project_id`, number, required): The project. Choose one of your projects or enter its ID. At least 1.
- Freelancer ID (`freelancer_id`, number, required): The freelancer's user ID. At least 1.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}
```

### List a project's bids

List the bids on one project.

**Inputs**

- Project (`project_id`, number, required): The project. Choose one of your projects or enter its ID. At least 1.
- Shortlisted only (`shortlisted_only`, true/false): Only the bids you shortlisted. For your own projects.
- Limit (`limit`, number): How many to return at most. From 1 to 100.
- Offset (`offset`, number): How many to skip, to read the next page. At least 0.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "bids": [
        {
          "amount": 1,
          "award_status": "example",
          "bidder_id": 1,
          "complete_status": "example",
          "description": "example",
          "frontend_bid_status": "example",
          "id": 1,
          "milestone_percentage": 1,
          "paid_status": "example",
          "period": 1,
          "project_id": 1,
          "project_owner_id": 1,
          "retracted": true,
          "time_submitted": 1
        }
      ],
      "total_count": 1
    },
    "status": "example"
  }
}
```

### List bids

List bids by project, by bidder or by project owner.

**Inputs**

- Projects (`projects`, list): Only bids on these project IDs.
- Bidders (`bidders`, list): Only bids by these user IDs.
- Project owners (`project_owners`, list): Only bids on projects posted by these user IDs.
- Award statuses (`award_statuses`, list): Only bids with these award states. One or more of: `awarded`, `rejected`, `revoked`, `pending`, `canceled`.
- Placed after (`placed_after`, date and time): Only bids placed at or after this time.
- Limit (`limit`, number): How many to return at most. From 1 to 100.
- Offset (`offset`, number): How many to skip, to read the next page. At least 0.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "bids": [
        {
          "amount": 1,
          "award_status": "example",
          "bidder_id": 1,
          "complete_status": "example",
          "description": "example",
          "frontend_bid_status": "example",
          "id": 1,
          "milestone_percentage": 1,
          "paid_status": "example",
          "period": 1,
          "project_id": 1,
          "project_owner_id": 1,
          "retracted": true,
          "time_submitted": 1
        }
      ],
      "total_count": 1
    },
    "status": "example"
  }
}
```

### List currencies

List the currencies Freelancer takes, with their IDs.

**Inputs**

- Codes (`codes`, list): Only these currency codes, such as USD.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "currencies": [
        {
          "code": "example",
          "exchange_rate": 1,
          "id": 1,
          "name": "example",
          "sign": "example"
        }
      ]
    },
    "status": "example"
  }
}
```

### List message threads

List your message threads, most recently active first.

**Inputs**

- Projects (`projects`, list): Only threads about these project IDs.
- Members (`members`, list): Only threads with these user IDs in them.
- Read (`is_read`, true/false): On for only threads you have read, off for only unread ones. Leave empty for both.
- Limit (`limit`, number): How many to return at most. From 1 to 100.
- Offset (`offset`, number): How many to skip, to read the next page. At least 0.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "threads": [
        {
          "id": 1,
          "message_count": 1,
          "thread": {
            "context": {
              "id": 1,
              "type": "example"
            },
            "id": 1,
            "members": [
              1
            ],
            "owner": 1,
            "thread_type": "example",
            "time_created": 1
          },
          "time_updated": 1
        }
      ]
    },
    "status": "example"
  }
}
```

### List messages

List messages, by thread or sender, newest first.

**Inputs**

- Threads (`threads`, list): Only messages in these thread IDs.
- Senders (`senders`, list): Only messages from these user IDs.
- Sent after (`sent_after`, date and time): Only messages sent at or after this time.
- Limit (`limit`, number): How many to return at most. From 1 to 100.
- Offset (`offset`, number): How many to skip, to read the next page. At least 0.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "messages": [
        {
          "from_user": 1,
          "id": 1,
          "message": "example",
          "message_source": "example",
          "thread_id": 1,
          "time_created": 1
        }
      ]
    },
    "status": "example"
  }
}
```

### List milestone payments

List milestone payments by project, user or state.

**Inputs**

- Projects (`projects`, list): Only milestones on these project IDs.
- Users (`users`, list): Only milestones between these user IDs, as client or freelancer.
- Statuses (`statuses`, list): Only milestones in these states. One or more of: `pending`, `requested_release` (Requested release), `cleared`, `disputed`, `frozen`, `canceled`.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "milestones": {}
    },
    "status": "example"
  }
}
```

### List projects

List projects by who posted them or who bid on them, newest first.

**Inputs**

- Owners (`owners`, list): Only projects posted by these user IDs.
- Bidders (`bidders`, list): Only projects bid on by these user IDs.
- Statuses (`statuses`, list): Only projects in these states. One or more of: `open`, `work_in_progress` (Work in progress), `complete`, `pending`, `draft`.
- Updated after (`updated_after`, date and time): Only projects changed at or after this time.
- Limit (`limit`, number): How many to return at most. From 1 to 100.
- Offset (`offset`, number): How many to skip, to read the next page. At least 0.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "projects": [
        {
          "bid_stats": {
            "bid_avg": 1,
            "bid_count": 1
          },
          "budget": {
            "maximum": 1,
            "minimum": 1
          },
          "currency": {
            "code": "example",
            "exchange_rate": 1,
            "id": 1,
            "name": "example",
            "sign": "example"
          },
          "description": "example",
          "frontend_project_status": "example",
          "id": 1,
          "jobs": [
            {
              "id": 1,
              "name": "example"
            }
          ],
          "owner_id": 1,
          "preview_description": "example",
          "seo_url": "example",
          "status": "example",
          "sub_status": "example",
          "time_submitted": 1,
          "time_updated": 1,
          "title": "example",
          "type": "example"
        }
      ],
      "total_count": 1
    },
    "status": "example"
  }
}
```

### List skills

List the skills (Freelancer calls them jobs) a project can ask for, with their IDs.

**Inputs**

- Names (`names`, list): Only the skills with these exact names, such as PHP.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": [
      {
        "category": {
          "id": 1,
          "name": "example"
        },
        "id": 1,
        "name": "example"
      }
    ],
    "status": "example"
  }
}
```

### Place a bid

Bid on a project as the connected freelancer account.

**Inputs**

- Project ID (`project_id`, number, required): The project to bid on. At least 1.
- Your user ID (`bidder_id`, number, required): Your own user ID. Get my profile returns it. At least 1.
- Amount (`amount`, number, required): The amount you bid, in the project's currency. At least 0.
- Days (`days`, number, required): How many days you need to finish the work. At least 1.
- Milestone percentage (`milestone_percentage`, number, required): The share of the amount, from 0 to 100, to be paid through milestones. From 0 to 100.
- Proposal (`proposal`, text): Your proposal to the client.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "amount": 1,
      "award_status": "example",
      "bidder_id": 1,
      "complete_status": "example",
      "description": "example",
      "frontend_bid_status": "example",
      "id": 1,
      "milestone_percentage": 1,
      "paid_status": "example",
      "period": 1,
      "project_id": 1,
      "project_owner_id": 1,
      "retracted": true,
      "time_submitted": 1
    },
    "status": "example"
  }
}
```

### Post a project

Post a new project for freelancers to bid on. It is public on Freelancer once it is live.

**Inputs**

- Title (`title`, text, required): The project's title.
- Description (`description`, text, required): What the work is.
- Currency (`currency_id`, number, required): The currency of the budget. At least 1.
- Budget minimum (`budget_minimum`, number, required): The least you would pay: in total for a fixed-price project, per hour for an hourly one. At least 0.
- Budget maximum (`budget_maximum`, number): The most you would pay. Leave empty for no upper limit. At least 0.
- Skills (`skills`, list, required): Skills (Freelancer calls them jobs) the work needs.
- Project type (`project_type`, text): Fixed price or paid by the hour. One of: `FIXED`, `HOURLY`. Default: `FIXED`.
- Hours (`hours`, number): For an hourly project: how many hours the work needs each week or month. At least 1.
- Hours per (`hours_per`, text): For an hourly project: whether those hours are a week's or a month's. One of: `WEEK`, `MONTH`. Default: `WEEK`.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "bid_stats": {
        "bid_avg": 1,
        "bid_count": 1
      },
      "budget": {
        "maximum": 1,
        "minimum": 1
      },
      "currency": {
        "code": "example",
        "exchange_rate": 1,
        "id": 1,
        "name": "example",
        "sign": "example"
      },
      "description": "example",
      "frontend_project_status": "example",
      "id": 1,
      "jobs": [
        {
          "id": 1,
          "name": "example"
        }
      ],
      "owner_id": 1,
      "preview_description": "example",
      "seo_url": "example",
      "status": "example",
      "sub_status": "example",
      "time_submitted": 1,
      "time_updated": 1,
      "title": "example",
      "type": "example"
    },
    "status": "example"
  }
}
```

### Search open projects

Search the projects open for bids on Freelancer.

**Inputs**

- Query (`query`, text): Words to look for in project titles and descriptions.
- Skills (`skills`, list): Skills (Freelancer calls them jobs) the work needs.
- Project types (`project_types`, list): Only fixed-price or only hourly projects. One or more of: `fixed`, `hourly`.
- Min price (`min_price`, number): Only projects whose fixed-price budget starts at this many US dollars or more. At least 0.
- Max price (`max_price`, number): Only projects whose fixed-price budget goes up to this many US dollars or less. At least 0.
- Countries (`countries`, list): Only projects from these countries, as two-letter codes such as us.
- Sort by (`sort_by`, text): How to order the results. Left empty, the best matches come first. One of: `time_updated` (Time updated), `bid_count` (Bid count), `bid_enddate` (Bid enddate), `bid_avg_usd` (Bid avg usd).
- Limit (`limit`, number): How many to return at most. From 1 to 100.
- Offset (`offset`, number): How many to skip, to read the next page. At least 0.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "projects": [
        {
          "bid_stats": {
            "bid_avg": 1,
            "bid_count": 1
          },
          "budget": {
            "maximum": 1,
            "minimum": 1
          },
          "currency": {
            "code": "example",
            "exchange_rate": 1,
            "id": 1,
            "name": "example",
            "sign": "example"
          },
          "description": "example",
          "frontend_project_status": "example",
          "id": 1,
          "jobs": [
            {
              "id": 1,
              "name": "example"
            }
          ],
          "owner_id": 1,
          "preview_description": "example",
          "seo_url": "example",
          "status": "example",
          "sub_status": "example",
          "time_submitted": 1,
          "time_updated": 1,
          "title": "example",
          "type": "example"
        }
      ],
      "total_count": 1
    },
    "status": "example"
  }
}
```

### Send a message

Send a message in an existing thread.

**Inputs**

- Thread ID (`thread_id`, number, required): The thread's ID. List message threads returns it. At least 1.
- Message (`message`, text, required): The message.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "from_user": 1,
      "id": 1,
      "message": "example",
      "message_source": "example",
      "thread_id": 1,
      "time_created": 1
    },
    "status": "example"
  }
}
```

### Start a conversation

Message one or more Freelancer users in a new thread, optionally about one of your projects.

**Inputs**

- Members (`members`, list, required): The user IDs to message.
- Message (`message`, text, required): The first message.
- Project (`project_id`, number): The project the conversation is about. Leave empty for a general conversation. At least 1.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "id": 1,
      "message_count": 1,
      "thread": {
        "context": {
          "id": 1,
          "type": "example"
        },
        "id": 1,
        "members": [
          1
        ],
        "owner": 1,
        "thread_type": "example",
        "time_created": 1
      },
      "time_updated": 1
    },
    "status": "example"
  }
}
```

### Update a bid

Change your bid's amount, proposal or milestone share.

**Inputs**

- Bid ID (`bid_id`, number, required): The bid's ID. At least 1.
- Amount (`amount`, number): The new amount, in the project's currency. At least 0.
- Proposal (`proposal`, text): The new proposal.
- Milestone percentage (`milestone_percentage`, number): The new share, from 0 to 100, to be paid through milestones. From 0 to 100.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "result": {
      "amount": 1,
      "award_status": "example",
      "bidder_id": 1,
      "complete_status": "example",
      "description": "example",
      "frontend_bid_status": "example",
      "id": 1,
      "milestone_percentage": 1,
      "paid_status": "example",
      "period": 1,
      "project_id": 1,
      "project_owner_id": 1,
      "retracted": true,
      "time_submitted": 1
    },
    "status": "example"
  }
}
```

### Update a project's description

Change a project's description or skills.

**Inputs**

- Project (`project_id`, number, required): The project. Choose one of your projects or enter its ID. At least 1.
- Description (`description`, text): The new description.
- Skills (`skills`, list): The new skills. They replace the project's current ones.

**Outputs**

- `data` (object): The response from Freelancer.

**Example output**

```json
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}
```
