Skip to main content
POST
/
employees
Create an employee
curl --request POST \
  --url https://api.getprimo.com/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "startDate": "2023-11-07T05:31:56Z",
  "managerId": "<string>",
  "teams": [
    "<string>"
  ],
  "jobs": [
    "<string>"
  ],
  "groups": [
    "<string>"
  ],
  "workLocation": "<string>",
  "legalEntity": "<string>"
}
'
{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "jobs": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "deviceIds": [
    "<string>"
  ],
  "accessoryIds": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "managerId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "terminationDate": "2023-11-07T05:31:56Z"
}

Documentation Index

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

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

Key: Write Scope: Company

Authorizations

​
Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json
​
firstName
string
required

First name of the employee

Minimum string length: 1
​
lastName
string
required

Last name of the employee

Minimum string length: 1
​
email
string<email>
required

Work email address of the employee

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
startDate
string<date-time> | null

Employment start date (ISO 8601)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
managerId
string | null

ID of the manager employee

​
teams
string[]

List of team names

​
jobs
string[]

List of job titles

​
groups
string[]

List of group names

​
workLocation
string | null

Work location name

​
legalEntity
string | null

Legal entity name

Response

default - application/json
​
id
string
required
​
firstName
string
required
​
lastName
string
required
​
email
string
required
​
teams
object[]
required
​
jobs
object[]
required
​
groups
object[]
required
​
onboardingStatus
enum<string> | null
required
Available options:
PENDING,
SCHEDULED,
IN_PROGRESS,
CLOSED,
CANCELED
​
offboardingStatus
enum<string> | null
required
Available options:
PENDING,
SCHEDULED,
IN_PROGRESS,
CLOSED,
CANCELED
​
deviceIds
string[]
required
​
accessoryIds
string[]
required
​
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
workLocation
object
​
legalEntity
object
​
managerId
string | null
​
startDate
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
terminationDate
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$