Get a school
curl --request GET \
--url https://{host}/primula/api/v3/schools/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/schools/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/schools/{id}', 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://{host}/primula/api/v3/schools/{id}",
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://{host}/primula/api/v3/schools/{id}"
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))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/schools/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/schools/{id}")
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{
"id": "<string>",
"name": "<string>",
"capacity": 123,
"full_name": "<string>",
"gusto_company_uuid": "<string>",
"gusto_company_id": "<string>",
"company_id": "<string>",
"street_address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"phone": "<string>",
"time_zone": "<string>",
"inquiry_call_pre_screen": true,
"is_active": true,
"is_procare_online": true,
"is_procare_online_leads": true,
"procare_desktop_id": "<string>",
"procare_desktop_name": "<string>",
"hide_billing_plan_alerts": true,
"intellikid_location_id": "<string>",
"IsIntellikidSchoolWithNoLeadsInProcare": true,
"lineleader_center_id": 123,
"lineleader_center_name": "<string>",
"lineleader_center_code": "<string>"
}Schools
Get a school
Scoped to company_id; the handler does not restrict this read to the session school assignments. Returns 404 when the school does not exist for the requested company.
GET
/
schools
/
{id}
Get a school
curl --request GET \
--url https://{host}/primula/api/v3/schools/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/schools/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/schools/{id}', 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://{host}/primula/api/v3/schools/{id}",
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://{host}/primula/api/v3/schools/{id}"
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))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/schools/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/schools/{id}")
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{
"id": "<string>",
"name": "<string>",
"capacity": 123,
"full_name": "<string>",
"gusto_company_uuid": "<string>",
"gusto_company_id": "<string>",
"company_id": "<string>",
"street_address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"phone": "<string>",
"time_zone": "<string>",
"inquiry_call_pre_screen": true,
"is_active": true,
"is_procare_online": true,
"is_procare_online_leads": true,
"procare_desktop_id": "<string>",
"procare_desktop_name": "<string>",
"hide_billing_plan_alerts": true,
"intellikid_location_id": "<string>",
"IsIntellikidSchoolWithNoLeadsInProcare": true,
"lineleader_center_id": 123,
"lineleader_center_name": "<string>",
"lineleader_center_code": "<string>"
}Authorizations
Access token issued by POST /sessions and associated with a valid server-side session.
Path Parameters
UUID identifying this resource.
Query Parameters
Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.
Response
Successful response.
School.
Company id.
The API currently serializes this property with the exact capitalization shown.