/freelancer/users/search

POST /api/freelancer/users/search

Price: 20 credits

Search the Freelancer.com freelancer directory by keyword and filters: skill ids, country, hourly-rate range, minimum star rating, minimum review count and online status. Each result is a full profile with reputation, skills, qualifications and verifications.

How to use it

Search Freelancer.com freelancers. All filters are optional except count. Use query for keywords, skills (numeric skill ids), countries (FULL country names such as India or United States, not codes), min_hourly_rate/max_hourly_rate, min_rating (1-5), min_review_count and online_only. sort accepts rating, hourly_rate or review_count. Each item is a full user profile — pass its alias to the Freelancer user endpoint, or to the user reviews and portfolio endpoints for detail.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Keyword to match against profile name, tagline and description (examples: "shopify")
• skills array nullable — Skill ids the freelancer must list on their profile (examples: [3,13])
• countries array nullable — Full country names the freelancer is based in (examples: ["India","United States"])
• min_hourly_rate number nullable — Lowest advertised hourly rate to accept (examples: 25; >: 0)
• max_hourly_rate number nullable — Highest advertised hourly rate to accept (examples: 150; >: 0)
• min_rating integer nullable — Lowest overall star rating to accept (examples: 4; min: 1; max: 5)
• min_review_count integer nullable — Lowest number of reviews to accept (examples: 50; min: 1)
• online_only boolean nullable — Keep only freelancers who are online right now
• sort string nullable — Ordering of the result list (one of: "rating", "hourly_rate", "review_count")
• reverse_sort boolean nullable — Flip the chosen ordering
• count integer required — Max number of freelancers to return (min: 1)

Response

• @type string (default: "FreelancerUser")
• id integer required
• alias string nullable
• display_name string nullable
• public_name string nullable
• tagline string nullable
• description string nullable
• company string nullable
• role string nullable
• chosen_role string nullable
• profile_url string nullable
• image string nullable
• hourly_rate number nullable
• primary_currency object nullable
  • @type string (default: "FreelancerCurrency")
  • code string nullable
  • sign string nullable
  • name string nullable
  • country string nullable
  • exchange_rate number nullable
• primary_language string nullable
• location object nullable
  • @type string (default: "FreelancerLocation")
  • country string nullable
  • country_code string nullable
  • city string nullable
  • administrative_area string nullable
  • postal_code string nullable
  • latitude number nullable
  • longitude number nullable
• timezone string nullable
• skills array (default: [])
  • @type string (default: "FreelancerSkill")
  • id integer required
  • name string nullable
  • alias string nullable
  • category_id integer nullable
  • category_name string nullable
  • is_local boolean nullable
• reputation object nullable
  • @type string (default: "FreelancerReputation")
  • entire_history object nullable
    • @type string (default: "FreelancerReputationPeriod")
    • overall number nullable
    • review_count integer nullable
    • complete_count integer nullable
    • incomplete_count integer nullable
    • on_budget number nullable
    • on_time number nullable
    • completion_rate number nullable
    • quality number nullable
    • communication number nullable
    • expertise number nullable
    • professionalism number nullable
    • hire_again number nullable
    • clarity_spec number nullable
    • payment_prom number nullable
    • work_for_again number nullable
  • last_3_months object nullable
    • @type string (default: "FreelancerReputationPeriod")
    • overall number nullable
    • review_count integer nullable
    • complete_count integer nullable
    • incomplete_count integer nullable
    • on_budget number nullable
    • on_time number nullable
    • completion_rate number nullable
    • quality number nullable
    • communication number nullable
    • expertise number nullable
    • professionalism number nullable
    • hire_again number nullable
    • clarity_spec number nullable
    • payment_prom number nullable
    • work_for_again number nullable
  • last_12_months object nullable
    • @type string (default: "FreelancerReputationPeriod")
    • overall number nullable
    • review_count integer nullable
    • complete_count integer nullable
    • incomplete_count integer nullable
    • on_budget number nullable
    • on_time number nullable
    • completion_rate number nullable
    • quality number nullable
    • communication number nullable
    • expertise number nullable
    • professionalism number nullable
    • hire_again number nullable
    • clarity_spec number nullable
    • payment_prom number nullable
    • work_for_again number nullable
  • earnings_score number nullable
  • job_history array (default: [])
    • @type string (default: "FreelancerJobHistoryItem")
    • skill_id integer nullable
    • skill_name string nullable
    • category_name string nullable
    • project_count integer nullable
  • other_project_count integer nullable
• employer_reputation object nullable
  • @type string (default: "FreelancerReputation")
  • entire_history object nullable
    • @type string (default: "FreelancerReputationPeriod")
    • overall number nullable
    • review_count integer nullable
    • complete_count integer nullable
    • incomplete_count integer nullable
    • on_budget number nullable
    • on_time number nullable
    • completion_rate number nullable
    • quality number nullable
    • communication number nullable
    • expertise number nullable
    • professionalism number nullable
    • hire_again number nullable
    • clarity_spec number nullable
    • payment_prom number nullable
    • work_for_again number nullable
  • last_3_months object nullable
    • @type string (default: "FreelancerReputationPeriod")
    • overall number nullable
    • review_count integer nullable
    • complete_count integer nullable
    • incomplete_count integer nullable
    • on_budget number nullable
    • on_time number nullable
    • completion_rate number nullable
    • quality number nullable
    • communication number nullable
    • expertise number nullable
    • professionalism number nullable
    • hire_again number nullable
    • clarity_spec number nullable
    • payment_prom number nullable
    • work_for_again number nullable
  • last_12_months object nullable
    • @type string (default: "FreelancerReputationPeriod")
    • overall number nullable
    • review_count integer nullable
    • complete_count integer nullable
    • incomplete_count integer nullable
    • on_budget number nullable
    • on_time number nullable
    • completion_rate number nullable
    • quality number nullable
    • communication number nullable
    • expertise number nullable
    • professionalism number nullable
    • hire_again number nullable
    • clarity_spec number nullable
    • payment_prom number nullable
    • work_for_again number nullable
  • earnings_score number nullable
  • job_history array (default: [])
    • @type string (default: "FreelancerJobHistoryItem")
    • skill_id integer nullable
    • skill_name string nullable
    • category_name string nullable
    • project_count integer nullable
  • other_project_count integer nullable
• verification object nullable
  • @type string (default: "FreelancerVerification")
  • is_payment_verified boolean nullable
  • is_email_verified boolean nullable
  • is_phone_verified boolean nullable
  • is_identity_verified boolean nullable
  • is_deposit_made boolean nullable
  • is_profile_complete boolean nullable
  • is_facebook_connected boolean nullable
  • is_linkedin_connected boolean nullable
  • is_freelancer_verified boolean nullable
• qualifications array (default: [])
  • @type string (default: "FreelancerQualification")
  • id integer required
  • name string nullable
  • qualification_type string nullable
  • description string nullable
  • level integer nullable
  • score_percentage number nullable
  • user_percentile number nullable
  • image string nullable
• badges array (default: [])
  • @type string (default: "FreelancerBadge")
  • id integer required
  • name string nullable
  • description string nullable
  • image string nullable
  • awarded_at integer nullable
• membership object nullable
  • @type string (default: "FreelancerMembership")
  • id integer nullable
  • name string nullable
• portfolio_count integer nullable
• recommendation_count integer nullable
• responsiveness number nullable
• is_preferred_freelancer boolean nullable
• is_profile_visible boolean nullable
• is_limited_account boolean nullable
• is_closed boolean nullable
• registered_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.