Company

Get the company's Setup

Return the company’s Setup, the checklist that takes a new customer from signing to running Primo: upNext, the tasks to do first, and sections, every task by product with its status (TODO, IN_PROGRESS, DONE or SKIPPED), who moved it, why Primo AI skipped it, whether it can start, and names, the HRIS, MDMs or country it is about; then facts, what Primo knows of the company’s stack. Use it to see where the company stands on each Setup task. started is false when the company has no Setup to show yet. This is the company’s own setup in Primo, not an employee onboarding: for those, use getOnboardings instead. Only accessible with a Company API key.

GET

company

setup

curl --request GET \
  --url https://api.getprimo.com/company/setup \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getprimo.com/company/setup', 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/company/setup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getprimo.com/company/setup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "started": true,
  "completedAt": "2023-11-07T05:31:56Z",
  "upNext": [
    {
      "key": "<string>",
      "item": "<string>",
      "product": "<string>",
      "status": "TODO",
      "by": "<string>",
      "skipReason": "<string>",
      "canStart": true,
      "startsAfter": [
        "<string>"
      ],
      "doItForMe": true,
      "minutes": 0,
      "helpCenterUrl": "<string>",
      "names": {}
    }
  ],
  "sections": [
    {
      "product": "<string>",
      "done": 0,
      "total": 0,
      "tasks": [
        {
          "key": "<string>",
          "item": "<string>",
          "product": "<string>",
          "status": "TODO",
          "by": "<string>",
          "skipReason": "<string>",
          "canStart": true,
          "startsAfter": [
            "<string>"
          ],
          "doItForMe": true,
          "minutes": 0,
          "helpCenterUrl": "<string>",
          "names": {}
        }
      ]
    }
  ],
  "facts": {}
}

Key: Read Scope: Company

Authorizations

Authorization

string

header

required

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

Response

default - application/json

started

boolean

required

False when the company has no Setup to show: no onboarding yet, or one still a draft

completedAt

string<date-time> | null

required

When the Setup ended; null while a task is open

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

upNext

object[]

required

The tasks the Setup page shows first, in order

Show child attributes

sections

object[]

required

Every task, by product, in the order of the Setup page

Show child attributes

facts

object

required

What Primo knows of the company's stack: devices, currentMdm, hris, emailProviders, chat, edr, buysDevices, admins

Show child attributes

Get the company's Setup

curl --request GET \
  --url https://api.getprimo.com/company/setup \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getprimo.com/company/setup', 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/company/setup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getprimo.com/company/setup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "started": true,
  "completedAt": "2023-11-07T05:31:56Z",
  "upNext": [
    {
      "key": "<string>",
      "item": "<string>",
      "product": "<string>",
      "status": "TODO",
      "by": "<string>",
      "skipReason": "<string>",
      "canStart": true,
      "startsAfter": [
        "<string>"
      ],
      "doItForMe": true,
      "minutes": 0,
      "helpCenterUrl": "<string>",
      "names": {}
    }
  ],
  "sections": [
    {
      "product": "<string>",
      "done": 0,
      "total": 0,
      "tasks": [
        {
          "key": "<string>",
          "item": "<string>",
          "product": "<string>",
          "status": "TODO",
          "by": "<string>",
          "skipReason": "<string>",
          "canStart": true,
          "startsAfter": [
            "<string>"
          ],
          "doItForMe": true,
          "minutes": 0,
          "helpCenterUrl": "<string>",
          "names": {}
        }
      ]
    }
  ],
  "facts": {}
}

Get started

API Reference

Get the company's Setup

Authorizations

Response