Skip to main content
POST
https://api.folkyn.com
/
api
/
v1
/
missions
curl --request POST \
  --url https://api.folkyn.com/api/v1/missions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Backend API — Q3",
  "description": "API development and maintenance for the Q3 release.",
  "mission_type": "daily",
  "contract_type": "services_agreement",
  "rate_amount": 650,
  "start_date": "2026-07-01",
  "end_date": "2026-12-31",
  "freelancer_id": "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee",
  "team_signer_id": "bbbbbbbb-cccc-4ddd-eeee-ffffffffffff",
  "use_folkyn_template": true,
  "template_locale": "fr"
}
'
{
  "data": {
    "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>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <your_api_key>

Body

application/json
​
name
string
required
​
description
string
required

Mission objectives, deliverables, and working conditions (same as the Folkyn app).

​
mission_type
enum<string>
required

Billing model for the mission (Postgres enum mission_type). hourly / daily / monthly use rate_amount as the price per that unit in currency. deliverable missions bill via the deliverables catalog (quantities and line amounts); rate_amount may still be set as a reference but line totals come from catalog rows on mission detail.

Available options:
hourly,
daily,
monthly,
deliverable
​
start_date
string<date>
required

YYYY-MM-DD

​
end_date
string<date>
required

YYYY-MM-DD

​
freelancer_id
string<uuid>
required

Active freelancer profile UUID on the team.

​
contract_type
enum<string>
default:services_agreement
Available options:
services_agreement,
master_agreement
​
rate_amount
number

Required for hourly, daily, and monthly missions (HT unit rate). Omit for deliverable missions.

​
team_signer_id
string<uuid>

Required when generating a contract from a template (folkyn_template_id or master_agreement_template_id). Active team member profile UUID as company signatory.

​
purchase_order
string
​
project_code_id
string<uuid>
​
referent_id
string<uuid>
​
approver_id
string<uuid>

Active team-admin UUID — mission stays in draft until approved in the Folkyn app.

​
use_folkyn_template
boolean

Set true to generate a services-agreement PDF from a DOCX template.

​
template_locale
enum<string>

Folkyn default prestation template language. Use instead of folkyn_template_id when you do not have the template UUID.

Available options:
fr,
en
​
folkyn_template_id
string<uuid>

Prestation template UUID — your team template (Settings) or a Folkyn global template. Alternative to template_locale.

​
master_agreement_template_id
string<uuid>

Team DOCX template UUID (master_agreement only). Requires team_signer_id and master_agreement_valid_until.

​
master_agreement_valid_until
string<date>

Framework agreement end date (YYYY-MM-DD). Required with master_agreement_template_id.

​
deliverables
object[]

Required when mission_type is deliverable.

​
allow_expired_signature
boolean
default:true

Response

Created — same object as GET /api/v1/missions/{id}

​
data
object