Invites
List invites
Returns a paginated list of invites belonging to the authenticated partner.
GET
/
v1
/
invites
List invites
curl --request GET \
--url https://api.theguarantors.com/v1/invites \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.theguarantors.com/v1/invites"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.theguarantors.com/v1/invites', 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.theguarantors.com/v1/invites",
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: Basic <encoded-value>"
],
]);
$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.theguarantors.com/v1/invites"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.theguarantors.com/v1/invites")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"total_items": 2,
"total_pages": 1,
"current_page": 1,
"items_per_page": 10,
"items": [
{
"id": "inv_8f3k2jd9slq02mxp",
"status": "created",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"application_id": null,
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_q7ghmgtaavp37krc",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_q7ghmgtaavp37krc",
"email": "jane.doe@example.com",
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+12125551234",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
},
{
"id": "inv_2pq8r4xv7nb91lws",
"status": "created",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"application_id": null,
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-04-15",
"end_date": "2027-04-14",
"monthly_rent": 285000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "456 Oak Ave",
"line2": "Unit 12",
"city": "Brooklyn",
"state": "NY",
"postal_code": "11201",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_h4kn8mzcwxr52pjy",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_h4kn8mzcwxr52pjy",
"email": "john.smith@example.com",
"first_name": "John",
"last_name": "Smith",
"phone_number": "+13475559876",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
}
]
}{
"message": "validation error: invalid pagination parameters: value for page should be a valid integer greater than 0",
"object": "error"
}{
"message": "Missing authorization header",
"object": "error"
}{
"message": "internal server error",
"object": "error"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Only return invites for this property
Page number, starting at 1
Required range:
x >= 1Items per page (max 500)
Required range:
1 <= x <= 500⌘I
List invites
curl --request GET \
--url https://api.theguarantors.com/v1/invites \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.theguarantors.com/v1/invites"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.theguarantors.com/v1/invites', 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.theguarantors.com/v1/invites",
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: Basic <encoded-value>"
],
]);
$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.theguarantors.com/v1/invites"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.theguarantors.com/v1/invites")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"total_items": 2,
"total_pages": 1,
"current_page": 1,
"items_per_page": 10,
"items": [
{
"id": "inv_8f3k2jd9slq02mxp",
"status": "created",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"application_id": null,
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_q7ghmgtaavp37krc",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_q7ghmgtaavp37krc",
"email": "jane.doe@example.com",
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+12125551234",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
},
{
"id": "inv_2pq8r4xv7nb91lws",
"status": "created",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"application_id": null,
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-04-15",
"end_date": "2027-04-14",
"monthly_rent": 285000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "456 Oak Ave",
"line2": "Unit 12",
"city": "Brooklyn",
"state": "NY",
"postal_code": "11201",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_h4kn8mzcwxr52pjy",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_h4kn8mzcwxr52pjy",
"email": "john.smith@example.com",
"first_name": "John",
"last_name": "Smith",
"phone_number": "+13475559876",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
}
]
}{
"message": "validation error: invalid pagination parameters: value for page should be a valid integer greater than 0",
"object": "error"
}{
"message": "Missing authorization header",
"object": "error"
}{
"message": "internal server error",
"object": "error"
}