Skip to main content
Create Employee
curl --request POST \
  --url https://integration.getmateo.com/api/v1/employee \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_admin": false,
  "username": "<string>",
  "signature": "<string>",
  "full_name": "<string>",
  "email": "<string>",
  "display_name": "<string>"
}
'
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_admin": false,
  "username": "<string>",
  "signature": "<string>",
  "full_name": "<string>",
  "email": "<string>",
  "display_name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getmateo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
select
string

Filtering Columns

Body

application/json

employee

​
id
string<uuid>
default:random uuid

Employee ID

​
created_at
string<timestamp with time zone>
default:now()

Employee creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid>

Organisation ID

​
user_id
string<uuid> | null

User ID

​
is_admin
boolean<boolean> | null
default:false

Is employee an admin?

​
username
string<text>

Name of employee

​
signature
string<text> | null

Signature of employee

​
full_name
string<text> | null

Name of employee

​
email
string<text> | null

Email of employee

​
display_name
string<text>

Displayed name of the employee in the Mateo app

Response

The updated Employee object

​
id
string<uuid>
default:random uuid

Employee ID

​
created_at
string<timestamp with time zone>
default:now()

Employee creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid>

Organisation ID

​
user_id
string<uuid> | null

User ID

​
is_admin
boolean<boolean> | null
default:false

Is employee an admin?

​
username
string<text>

Name of employee

​
signature
string<text> | null

Signature of employee

​
full_name
string<text> | null

Name of employee

​
email
string<text> | null

Email of employee

​
display_name
string<text>

Displayed name of the employee in the Mateo app