The FreelanceLink API uses API keys to authenticate requests. You can view and manage your API keys in your Profile > API Key.
You authenticate your request by sending the API key in the Authorization header of your request. In the following example, replace YOUR-API-KEY with a reference to your key:
curl "<https://api.freelance.link/v1/>" \\
--header "Authorization: Bearer YOUR-API-KEY"
If you try to use an API endpoint without a key or with a key that has insufficient permissions, you will receive a 404 Not Found or 403 Forbidden response.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
FreelanceLink uses conventional HTTP response codes to indicate the success or failure of an API request.
In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with FreelanceLink’s servers.
| Code | Description |
|---|---|
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 402 - Request Failed | The parameters were valid but the request failed. |
| 403 - Forbidden | The API key doesn't have permissions to perform the request. |
| 404 - Not Found | The requested resource doesn't exist. |
Retrieve your availability for a valid username via **GET** /v1/users/{username}/availability
<aside>
💡 You can only retrieve your own availability. When you try to retrieve others’ availability, you’ll get a **403 - Forbidden** error.
</aside>
Sample request to retrieve an availability:
curl <https://api.freelance.link/v1/users/USERNAME/availability> \\
-H "Authorization: Bearer <YOUR-API-KEY>"