Skip to main content
POST
/
users
/
lookup
Resolve employee by exactly one identifier
curl --request POST \
  --url https://{host}/api/v1/users/lookup \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": 2,
  "phone": "<string>",
  "ssn": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "internal_id": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "address": "<string>",
  "postal_code": "<string>",
  "city": "<string>",
  "main_work": "true",
  "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
​
user_id
integer | null
Required range: x >= 1
​
phone
string | null
Maximum string length: 64
​
ssn
string | null
Maximum string length: 64

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