Skip to main content
POST
/
users
Create or link an employee by email
curl --request POST \
  --url https://app.easyfreelance.no/api/v1/users \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "internal_id": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "address": "<string>",
  "postal_code": "<string>",
  "city": "<string>",
  "dial_code": "<string>",
  "phone": "<string>",
  "note": "<string>",
  "bank_account_number": "<string>",
  "bank_iban_number": "<string>",
  "bank_bic_number": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "internal_id": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "address": "<string>",
  "postal_code": "<string>",
  "city": "<string>",
  "nationality": "<string>",
  "note": "<string>",
  "bank_account_number": "<string>",
  "bank_iban_number": "<string>",
  "bank_bic_number": "<string>",
  "tax_percent": "<string>",
  "tax_type": "<string>",
  "tax_start": "<string>",
  "tax_table": "<string>",
  "tax_free_card": "<string>",
  "onboarding": "<string>",
  "created_at": "<string>"
}

Authorizations

Authorization
string
header
required

Sanctum personal access token (access_tokens / partner API settings).

API-key
string
header
required

UUID API key stored for the partner user.

Body

application/json
email
string<email>
required

Required. Unique among all users when creating a new account.

Maximum string length: 254
internal_id
integer | null

Optional partner-specific ID; must be unique among your linked employees.

first_name
string | null
Maximum string length: 254
last_name
string | null
Maximum string length: 254
address
string | null
Maximum string length: 255
postal_code
string | null
Maximum string length: 10
city
string | null
Maximum string length: 255
dial_code
string | null

Phone country dial code (validated server-side).

Maximum string length: 254
phone
string | null

Digits only, 4–15 characters.

Pattern: ^[0-9]{4,15}$
main_work
enum<string> | null

Whether primary work is through EasyFreelance.

Available options:
true,
false
note
string | null

Partner-visible note stored on the user record when provided.

Maximum string length: 4096
bank_account_number
string | null

Norwegian domestic account; do not combine with IBAN/BIC in the same request.

bank_iban_number
string | null

International; send together with bank_bic_number.

bank_bic_number
string | null

International; send together with bank_iban_number.

Response

id
string
required
email
string
required
internal_id
string
required
name
required
phone
required
address
required
postal_code
required
city
required
main_work
enum<string>
required
Available options:
true,
false
nationality
required
note
required
bank_account_number
string | null
required
bank_iban_number
string | null
required
bank_bic_number
string | null
required
tax_percent
string | null
required
tax_type
required
tax_start
required
tax_table
required
tax_free_card
required
onboarding
string
required
created_at
string
required