Skip to main content
GET
https://api.folkyn.com
/
api
/
v1
/
missions
List Missions
curl --request GET \
  --url https://api.folkyn.com/api/v1/missions \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "has_document": true,
        "currency": "EUR",
        "rate_amount": 123,
        "client_rate_amount": 123,
        "start_date": "2023-12-25",
        "end_date": "2023-12-25",
        "external_referent": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "email": "<string>",
          "company": "<string>",
          "siren": "<string>",
          "address": "<string>",
          "postal_code": "<string>",
          "city": "<string>"
        },
        "purchase_order": "<string>",
        "project_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "project_code": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "external_id": "<string>"
        },
        "deliverables_catalog": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "quantity": 123,
            "amount_excl_vat": 123,
            "order_index": 123
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "created_by": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>"
        },
        "freelancer": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "<string>",
          "referent": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "first_name": "<string>",
            "last_name": "<string>",
            "email": "<string>"
          }
        },
        "team_signer": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "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 stored mission statuses (kebab-case). Values are normalized to lowercase.

Allowed values (database missions.status): draft, awaiting-freelancer-acceptance, awaiting-team-signature, in-progress, completed, terminated, deleted, rejected, cancelled.

Display-aligned filtering: for completed and in-progress, the API applies calendar logic vs end_date so the filter matches what users see in the app (e.g. an in-progress mission past end_date can count as completed).

Special case: filter awaiting-team-signature alone also includes in-progress missions (company signature workflow).

Response payloads expose a derived display_status (see schema MissionDisplayStatus), which can differ from missions.status.

​
start_date_from
string

Calendar YYYY-MM-DD. Keeps missions whose start_date is on or after this day (date-only string, same rule as the Folkyn app).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
​
created_at_from
string

Inclusive lower bound on missions.created_at. Calendar YYYY-MM-DD (UTC day start). Pairs with created_at_to.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
​
created_at_to
string

Inclusive upper bound on missions.created_at. Calendar YYYY-MM-DD (UTC day end). Must be ≥ created_at_from when both are set.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
​
project_code_id
string<uuid>

Filter missions linked to this team project code (UUID from GET /api/v1/project-codes). Mutually exclusive with has_project_code. Returns 400 if the id is not a valid UUID or does not belong to the API key's team.

​
has_project_code
enum<string>

Presence filter on project_code_id. Case-insensitive accepted values: with, without, true, false (also 1 / 0). with / true: mission has a project code. without / false: no project code. Mutually exclusive with project_code_id.

Available options:
with,
without,
true,
false,
1,
0
​
has_purchase_order
enum<string>

Presence filter on purchase_order. Same accepted values as has_project_code. with / true: non-empty purchase order (after trim). without / false: null, empty, or whitespace-only.

Available options:
with,
without,
true,
false,
1,
0
​
freelancer_id
string<uuid>

Restrict to missions assigned to this freelancer (UUID).

Response

Success

​
data
object