Services Report
curl --request POST \
--url https://brokers.newyorkcityservers.com/api/v1/reports/services \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
"[email protected]",
"[email protected]"
],
"status_filter": "active"
}
'import requests
url = "https://brokers.newyorkcityservers.com/api/v1/reports/services"
payload = {
"recipients": ["[email protected]", "[email protected]"],
"status_filter": "active"
}
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({
recipients: ['[email protected]', '[email protected]'],
status_filter: 'active'
})
};
fetch('https://brokers.newyorkcityservers.com/api/v1/reports/services', 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://brokers.newyorkcityservers.com/api/v1/reports/services",
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([
'recipients' => [
'[email protected]',
'[email protected]'
],
'status_filter' => 'active'
]),
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://brokers.newyorkcityservers.com/api/v1/reports/services"
payload := strings.NewReader("{\n \"recipients\": [\n \"[email protected]\",\n \"[email protected]\"\n ],\n \"status_filter\": \"active\"\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://brokers.newyorkcityservers.com/api/v1/reports/services")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n \"[email protected]\",\n \"[email protected]\"\n ],\n \"status_filter\": \"active\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brokers.newyorkcityservers.com/api/v1/reports/services")
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 \"recipients\": [\n \"[email protected]\",\n \"[email protected]\"\n ],\n \"status_filter\": \"active\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"report_type": "services",
"total_services": 145,
"recipients_sent": 2,
"recipients_failed": 0,
"filters": {
"status": "active"
},
"generated_at": "2026-06-21T15:00:00.000Z"
}
}
Services Report
Generate a services report and send it as an Excel email attachment.
POST
/
v1
/
reports
/
services
Services Report
curl --request POST \
--url https://brokers.newyorkcityservers.com/api/v1/reports/services \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
"[email protected]",
"[email protected]"
],
"status_filter": "active"
}
'import requests
url = "https://brokers.newyorkcityservers.com/api/v1/reports/services"
payload = {
"recipients": ["[email protected]", "[email protected]"],
"status_filter": "active"
}
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({
recipients: ['[email protected]', '[email protected]'],
status_filter: 'active'
})
};
fetch('https://brokers.newyorkcityservers.com/api/v1/reports/services', 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://brokers.newyorkcityservers.com/api/v1/reports/services",
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([
'recipients' => [
'[email protected]',
'[email protected]'
],
'status_filter' => 'active'
]),
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://brokers.newyorkcityservers.com/api/v1/reports/services"
payload := strings.NewReader("{\n \"recipients\": [\n \"[email protected]\",\n \"[email protected]\"\n ],\n \"status_filter\": \"active\"\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://brokers.newyorkcityservers.com/api/v1/reports/services")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": [\n \"[email protected]\",\n \"[email protected]\"\n ],\n \"status_filter\": \"active\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brokers.newyorkcityservers.com/api/v1/reports/services")
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 \"recipients\": [\n \"[email protected]\",\n \"[email protected]\"\n ],\n \"status_filter\": \"active\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"report_type": "services",
"total_services": 145,
"recipients_sent": 2,
"recipients_failed": 0,
"filters": {
"status": "active"
},
"generated_at": "2026-06-21T15:00:00.000Z"
}
}
Generate a report of the services in your broker account. The endpoint sends the report to the specified email addresses.
Spaces in the broker name become underscores. The attachment contains these columns:
| Column | Source |
|---|---|
Service ID | Service number |
Registration Date | Service creation date, formatted as MM/DD/YYYY |
Client Name | Customer name |
Client Email | Customer email address |
Plan | Service plan |
Status | Service status |
Errors
Error responses usesuccess: false and an error object.
| HTTP status | Error code | Message or cause |
|---|---|---|
400 | invalid_request | The body is not valid JSON. The message is Invalid JSON in request body. |
400 | missing_parameter | recipients is omitted or is null. The response lists recipients in required_fields. |
400 | invalid_parameter | recipients is not an array, contains a non-string or invalid address, or has no valid nonempty address. The response includes max_recipients: 10. |
400 | too_many_recipients | The normalized list has more than 10 unique recipients. The response includes max_recipients: 10. |
400 | invalid_parameter | status_filter is not an accepted value. The response lists the accepted values. |
400 | no_data | No service matches the filter. |
401 | authentication_failed | The Bearer token is missing, invalid, inactive, or expired. |
403 | insufficient_permissions | The request IP is not allowed, or the key does not have reports:generate or admin:full. |
429 | rate_limit_exceeded | The key reached its rate limit. Use the Retry-After response header. |
500 | server_error | The API could not read the service data or could not complete report generation. |
Authorizations
Send the API key in the Authorization bearer header. Production keys begin with sk_live_.
Body
application/json
Items are trimmed and lowercased; empty strings are ignored and duplicates are removed. Every remaining value must be an email address, and at most 10 unique nonempty recipients may remain.
Minimum array length:
1An omitted, null, or empty value applies the all filter.
Available options:
all, active, pending, suspended, cancelled, Last modified on August 2, 2026
⌘I

