List all contacts
curl --request GET \
--url https://portal.schoolcues.com/api/school/v1/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://portal.schoolcues.com/api/school/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://portal.schoolcues.com/api/school/v1/contacts', 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://portal.schoolcues.com/api/school/v1/contacts",
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://portal.schoolcues.com/api/school/v1/contacts"
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://portal.schoolcues.com/api/school/v1/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.schoolcues.com/api/school/v1/contacts")
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{
"data": [
{
"id": "<string>",
"givenName": "<string>",
"middleName": "<string>",
"familyName": "<string>",
"preferredName": "<string>",
"email": "<string>",
"phone": "<string>",
"students": [
{
"studentId": "<string>",
"relationship": "<string>",
"parent": true
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"statusCode": 123,
"statusMessage": "<string>"
}{
"statusCode": 123,
"statusMessage": "<string>"
}{
"statusCode": 123,
"statusMessage": "<string>"
}{
"statusCode": 123,
"statusMessage": "<string>"
}Contacts
List all contacts
A page of the school’s contacts, oldest change first. Pass the latest updatedAt you have read as updatedSince to read only what changed. Needs an API key that can read contacts (contacts:read).
GET
/
api
/
school
/
v1
/
contacts
List all contacts
curl --request GET \
--url https://portal.schoolcues.com/api/school/v1/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://portal.schoolcues.com/api/school/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://portal.schoolcues.com/api/school/v1/contacts', 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://portal.schoolcues.com/api/school/v1/contacts",
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://portal.schoolcues.com/api/school/v1/contacts"
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://portal.schoolcues.com/api/school/v1/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://portal.schoolcues.com/api/school/v1/contacts")
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{
"data": [
{
"id": "<string>",
"givenName": "<string>",
"middleName": "<string>",
"familyName": "<string>",
"preferredName": "<string>",
"email": "<string>",
"phone": "<string>",
"students": [
{
"studentId": "<string>",
"relationship": "<string>",
"parent": true
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"statusCode": 123,
"statusMessage": "<string>"
}{
"statusCode": 123,
"statusMessage": "<string>"
}{
"statusCode": 123,
"statusMessage": "<string>"
}{
"statusCode": 123,
"statusMessage": "<string>"
}Authorizations
One of the school’s API keys, from Settings › Integrations › API.