Freelancer

App · 23 actions

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

Actions

ActionWhat it does
Act on a bidAward, revoke, shortlist or hide a bid on your project, or accept, deny or retract your own bid.
Close a projectClose a project that is open for bids, so nobody can bid on it.
Create a milestone paymentPut money into a milestone payment for the freelancer you hired.
Get a bidGet one bid by its ID.
Get a projectGet one project, with its full description and skills.
Get a userGet a Freelancer user's public profile by their user ID.
Get my profileGet the Freelancer account this connection signs in as: its user ID, username and currency.
Invite a freelancer to bidInvite a freelancer to bid on one of your projects.
List a project's bidsList the bids on one project.
List bidsList bids by project, by bidder or by project owner.
List currenciesList the currencies Freelancer takes, with their IDs.
List message threadsList your message threads, most recently active first.
List messagesList messages, by thread or sender, newest first.
List milestone paymentsList milestone payments by project, user or state.
List projectsList projects by who posted them or who bid on them, newest first.
List skillsList the skills (Freelancer calls them jobs) a project can ask for, with their IDs.
Place a bidBid on a project as the connected freelancer account.
Post a projectPost a new project for freelancers to bid on.
Search open projectsSearch the projects open for bids on Freelancer.
Send a messageSend a message in an existing thread.
Start a conversationMessage one or more Freelancer users in a new thread, optionally about one of your projects.
Update a bidChange your bid's amount, proposal or milestone share.
Update a project's descriptionChange a project's description or skills.

Act on a bid

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

Inputs

Bid IDbid_idnumberRequired
The bid's ID.At least 1.
ActionoperationtextRequired
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

dataobject
The response from Freelancer.
Example output
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}

Close a project

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

Inputs

Projectproject_idnumberRequired
The project. Choose one of your projects or enter its ID.At least 1.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Projectproject_idnumberRequired
The project the payment is for.At least 1.
Freelancer IDfreelancer_idnumberRequired
The user ID of the freelancer you hired.At least 1.
AmountamountnumberRequired
The amount, in the project's currency.At least 0.01.
Reasonreasontext
What the payment is for.One of: partial_payment (Partial payment), full_payment (Full payment), task_description (Task description), other. Default: partial_payment.
Descriptiondescriptiontext
A note about the payment.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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 IDbid_idnumberRequired
The bid's ID.At least 1.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Projectproject_idnumberRequired
The project. Choose one of your projects or enter its ID.At least 1.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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 IDfreelancer_user_idnumberRequired
The user's ID.At least 1.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

dataobject
The response from Freelancer.
Example output
{
  "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

Projectproject_idnumberRequired
The project. Choose one of your projects or enter its ID.At least 1.
Freelancer IDfreelancer_idnumberRequired
The freelancer's user ID.At least 1.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}

List a project's bids

List the bids on one project.

Inputs

Projectproject_idnumberRequired
The project. Choose one of your projects or enter its ID.At least 1.
Shortlisted onlyshortlisted_onlytrue/false
Only the bids you shortlisted. For your own projects.
Limitlimitnumber
How many to return at most.From 1 to 100.
Offsetoffsetnumber
How many to skip, to read the next page.At least 0.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Projectsprojectslist
Only bids on these project IDs.
Biddersbidderslist
Only bids by these user IDs.
Project ownersproject_ownerslist
Only bids on projects posted by these user IDs.
Award statusesaward_statuseslist
Only bids with these award states.One or more of: awarded, rejected, revoked, pending, canceled.
Placed afterplaced_afterdate and time
Only bids placed at or after this time.
Limitlimitnumber
How many to return at most.From 1 to 100.
Offsetoffsetnumber
How many to skip, to read the next page.At least 0.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Codescodeslist
Only these currency codes, such as USD.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Projectsprojectslist
Only threads about these project IDs.
Membersmemberslist
Only threads with these user IDs in them.
Readis_readtrue/false
On for only threads you have read, off for only unread ones. Leave empty for both.
Limitlimitnumber
How many to return at most.From 1 to 100.
Offsetoffsetnumber
How many to skip, to read the next page.At least 0.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Threadsthreadslist
Only messages in these thread IDs.
Senderssenderslist
Only messages from these user IDs.
Sent aftersent_afterdate and time
Only messages sent at or after this time.
Limitlimitnumber
How many to return at most.From 1 to 100.
Offsetoffsetnumber
How many to skip, to read the next page.At least 0.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Projectsprojectslist
Only milestones on these project IDs.
Usersuserslist
Only milestones between these user IDs, as client or freelancer.
Statusesstatuseslist
Only milestones in these states.One or more of: pending, requested_release (Requested release), cleared, disputed, frozen, canceled.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "data": {
    "request_id": "example",
    "result": {
      "milestones": {}
    },
    "status": "example"
  }
}

List projects

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

Inputs

Ownersownerslist
Only projects posted by these user IDs.
Biddersbidderslist
Only projects bid on by these user IDs.
Statusesstatuseslist
Only projects in these states.One or more of: open, work_in_progress (Work in progress), complete, pending, draft.
Updated afterupdated_afterdate and time
Only projects changed at or after this time.
Limitlimitnumber
How many to return at most.From 1 to 100.
Offsetoffsetnumber
How many to skip, to read the next page.At least 0.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Namesnameslist
Only the skills with these exact names, such as PHP.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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 IDproject_idnumberRequired
The project to bid on.At least 1.
Your user IDbidder_idnumberRequired
Your own user ID. Get my profile returns it.At least 1.
AmountamountnumberRequired
The amount you bid, in the project's currency.At least 0.
DaysdaysnumberRequired
How many days you need to finish the work.At least 1.
Milestone percentagemilestone_percentagenumberRequired
The share of the amount, from 0 to 100, to be paid through milestones.From 0 to 100.
Proposalproposaltext
Your proposal to the client.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

TitletitletextRequired
The project's title.
DescriptiondescriptiontextRequired
What the work is.
Currencycurrency_idnumberRequired
The currency of the budget.At least 1.
Budget minimumbudget_minimumnumberRequired
The least you would pay: in total for a fixed-price project, per hour for an hourly one.At least 0.
Budget maximumbudget_maximumnumber
The most you would pay. Leave empty for no upper limit.At least 0.
SkillsskillslistRequired
Skills (Freelancer calls them jobs) the work needs.
Project typeproject_typetext
Fixed price or paid by the hour.One of: FIXED, HOURLY. Default: FIXED.
Hourshoursnumber
For an hourly project: how many hours the work needs each week or month.At least 1.
Hours perhours_pertext
For an hourly project: whether those hours are a week's or a month's.One of: WEEK, MONTH. Default: WEEK.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Queryquerytext
Words to look for in project titles and descriptions.
Skillsskillslist
Skills (Freelancer calls them jobs) the work needs.
Project typesproject_typeslist
Only fixed-price or only hourly projects.One or more of: fixed, hourly.
Min pricemin_pricenumber
Only projects whose fixed-price budget starts at this many US dollars or more.At least 0.
Max pricemax_pricenumber
Only projects whose fixed-price budget goes up to this many US dollars or less.At least 0.
Countriescountrieslist
Only projects from these countries, as two-letter codes such as us.
Sort bysort_bytext
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).
Limitlimitnumber
How many to return at most.From 1 to 100.
Offsetoffsetnumber
How many to skip, to read the next page.At least 0.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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 IDthread_idnumberRequired
The thread's ID. List message threads returns it.At least 1.
MessagemessagetextRequired
The message.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

MembersmemberslistRequired
The user IDs to message.
MessagemessagetextRequired
The first message.
Projectproject_idnumber
The project the conversation is about. Leave empty for a general conversation.At least 1.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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 IDbid_idnumberRequired
The bid's ID.At least 1.
Amountamountnumber
The new amount, in the project's currency.At least 0.
Proposalproposaltext
The new proposal.
Milestone percentagemilestone_percentagenumber
The new share, from 0 to 100, to be paid through milestones.From 0 to 100.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "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

Projectproject_idnumberRequired
The project. Choose one of your projects or enter its ID.At least 1.
Descriptiondescriptiontext
The new description.
Skillsskillslist
The new skills. They replace the project's current ones.

Outputs

dataobject
The response from Freelancer.
Example output
{
  "data": {
    "request_id": "example",
    "status": "example"
  }
}

On this page