Skip to main content
GET
https://api.folkyn.com
/
api
/
v1
/
freelancers
List Freelancers
curl --request GET \
  --url https://api.folkyn.com/api/v1/freelancers \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "external_id": "<string>",
        "job_title": "<string>",
        "note": "<string>",
        "referent": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "<string>"
        },
        "tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ],
        "teams": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "level": 2,
            "level_name": "<string>"
          }
        ],
        "kyc_complete": true,
        "master_agreement_active": true,
        "created_at": "2023-11-07T05:31:56Z",
        "first_name": "<string>",
        "last_name": "<string>"
      }
    ],
    "total": 123,
    "current_page": 123,
    "per_page": 123
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <your_api_key>

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:10
Required range: 1 <= x <= 100
​
status
string

Comma-separated roster segment: staffed, unstaffed, pending, archived, or all. staffed = at least one active mission; unstaffed = active link without such mission; pending = invitation not accepted (id is a team invitation id); archived = archived link. Omit status to exclude archived and pending; use all for no filter.

Example:

"staffed,unstaffed"

​
tag_ids
string

Comma-separated tag UUIDs (AND — freelancer must have all listed tags).

​
kyc_complete
enum<string>
Available options:
true,
false
​
master_agreement_active
enum<string>
Available options:
true,
false

Response

Success

​
data
object