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",
  "emails": [
    "jsmith@example.com"
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "managerId": "<string>",
  "teams": [
    "<string>"
  ],
  "jobs": [
    "<string>"
  ],
  "groups": [
    "<string>"
  ],
  "workLocation": "<string>",
  "legalEntity": "<string>"
}
'

import requests

url = "https://api.getprimo.com/employees"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "emails": ["jsmith@example.com"],
    "startDate": "2023-11-07T05:31:56Z",
    "managerId": "<string>",
    "teams": ["<string>"],
    "jobs": ["<string>"],
    "groups": ["<string>"],
    "workLocation": "<string>",
    "legalEntity": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    emails: ['jsmith@example.com'],
    startDate: '2023-11-07T05:31:56Z',
    managerId: '<string>',
    teams: ['<string>'],
    jobs: ['<string>'],
    groups: ['<string>'],
    workLocation: '<string>',
    legalEntity: '<string>'
  })
};

fetch('https://api.getprimo.com/employees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/employees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'emails' => [
        'jsmith@example.com'
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'managerId' => '<string>',
    'teams' => [
        '<string>'
    ],
    'jobs' => [
        '<string>'
    ],
    'groups' => [
        '<string>'
    ],
    'workLocation' => '<string>',
    'legalEntity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/employees"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"emails\": [\n    \"jsmith@example.com\"\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"managerId\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getprimo.com/employees")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"emails\": [\n    \"jsmith@example.com\"\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"managerId\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"emails\": [\n    \"jsmith@example.com\"\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"managerId\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "jobs": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "onboardingStatus": "PENDING",
  "offboardingStatus": "PENDING",
  "lastEnrollmentRequestSentAt": "2023-11-07T05:31:56Z",
  "enrollmentReminderEnabled": true,
  "enrollmentReminderStatus": "NEVER_SENT",
  "deviceIds": [
    "<string>"
  ],
  "accessoryIds": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "emails": [
    "<string>"
  ],
  "employmentType": "INTERNAL",
  "isRemote": true,
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "managerId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "terminationDate": "2023-11-07T05:31:56Z",
  "personalEmail": "<string>",
  "address": {
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "complement": "<string>",
    "countryCode": "<string>",
    "phone": "<string>"
  }
}

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",
  "emails": [
    "jsmith@example.com"
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "managerId": "<string>",
  "teams": [
    "<string>"
  ],
  "jobs": [
    "<string>"
  ],
  "groups": [
    "<string>"
  ],
  "workLocation": "<string>",
  "legalEntity": "<string>"
}
'

import requests

url = "https://api.getprimo.com/employees"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "emails": ["jsmith@example.com"],
    "startDate": "2023-11-07T05:31:56Z",
    "managerId": "<string>",
    "teams": ["<string>"],
    "jobs": ["<string>"],
    "groups": ["<string>"],
    "workLocation": "<string>",
    "legalEntity": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    emails: ['jsmith@example.com'],
    startDate: '2023-11-07T05:31:56Z',
    managerId: '<string>',
    teams: ['<string>'],
    jobs: ['<string>'],
    groups: ['<string>'],
    workLocation: '<string>',
    legalEntity: '<string>'
  })
};

fetch('https://api.getprimo.com/employees', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/employees",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'emails' => [
        'jsmith@example.com'
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'managerId' => '<string>',
    'teams' => [
        '<string>'
    ],
    'jobs' => [
        '<string>'
    ],
    'groups' => [
        '<string>'
    ],
    'workLocation' => '<string>',
    'legalEntity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/employees"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"emails\": [\n    \"jsmith@example.com\"\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"managerId\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getprimo.com/employees")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"emails\": [\n    \"jsmith@example.com\"\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"managerId\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"emails\": [\n    \"jsmith@example.com\"\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"managerId\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "jobs": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "onboardingStatus": "PENDING",
  "offboardingStatus": "PENDING",
  "lastEnrollmentRequestSentAt": "2023-11-07T05:31:56Z",
  "enrollmentReminderEnabled": true,
  "enrollmentReminderStatus": "NEVER_SENT",
  "deviceIds": [
    "<string>"
  ],
  "accessoryIds": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "emails": [
    "<string>"
  ],
  "employmentType": "INTERNAL",
  "isRemote": true,
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "managerId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "terminationDate": "2023-11-07T05:31:56Z",
  "personalEmail": "<string>",
  "address": {
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "complement": "<string>",
    "countryCode": "<string>",
    "phone": "<string>"
  }
}

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

string<email> | null

deprecated

Deprecated — use emails instead. Only added to emails.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

emails

string<email>[]

Every email address of the employee. Leave it out for a new hire whose addresses are not known yet. An address another employee holds refuses the creation (409).

Maximum array length: 20

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

string

required

firstName

string

required

lastName

string

required

string | null

required

deprecated

Deprecated — use emails on getEmployee. Primary address of the employee, derived from emails; null when they have none.

teams

object[]

required

Teams the employee belongs to. Empty only when no team is assigned — group by name to count per team.

Show child attributes

jobs

object[]

required

Job titles held by the employee. Empty only when no job title is assigned.

Show child attributes

groups

object[]

required

Employee groups the employee belongs to.

Show child attributes

onboardingStatus

enum<string> | null

required

Null when the employee has no onboarding.

Available options:

PENDING,

SCHEDULED,

IN_PROGRESS,

CLOSED,

CANCELED

offboardingStatus

enum<string> | null

required

Null when the employee has no offboarding.

Available options:

PENDING,

SCHEDULED,

IN_PROGRESS,

CLOSED,

CANCELED

lastEnrollmentRequestSentAt

string<date-time> | null

required

When the last MDM enrollment request was emailed to the employee (ISO 8601). Null if none ever was.

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))$

enrollmentReminderEnabled

boolean

required

Whether the built-in enrollment reminder job is allowed to re-send to this employee.

enrollmentReminderStatus

enum<string>

required

Where the employee stands in the built-in enrollment reminder cycle. See the tool description for what each value means.

Available options:

NEVER_SENT,

REMINDER_CYCLE_ACTIVE,

REMINDER_CYCLE_STALLED,

REMINDERS_DISABLED

deviceIds

string[]

required

Ids of the devices assigned to the employee.

accessoryIds

string[]

required

Ids of the accessories assigned to the employee.

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))$

emails

string[]

required

Every email address the employee is known by, the work and personal ones included. A new SaaS account is created with one of them: pass it as email to provisionSaasIdentity or createSaasProvisioningIntent.

employmentType

enum<string>

required

Employment type of the employee

Available options:

INTERNAL,

CONTRACTOR

isRemote

boolean

required

Whether the employee works remotely. Derived from the absence of a work location: an employee with no assigned work location has no office to deliver equipment to and is treated as remote.

workLocation

object | null

Office the employee is attached to. Null for a remote employee.

Show child attributes

legalEntity

object | null

Legal entity employing them.

Show child attributes

managerId

string | null

Id of the manager employee.

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))$

terminationDate

string<date-time> | null

Employment end 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))$

personalEmail

string | null

deprecated

Deprecated — use emails instead. Personal address of the employee, derived from emails: the first one on none of the company's domains, other than the primary address. Null when there is none.

address

object | null

Personal (home) address of the employee, when known. Use it as the HOME shipping address when ordering equipment for a remote employee. Null when the employee record has no address — ask for one instead of composing it.

Show child attributes

Get started

API Reference

Create an employee

Authorizations

Body

Response