View Party
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/users/get-users \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"partyNumber": 789,
"includeBills": true,
"page": {
"size": 50,
"pageNumber": 0
},
"method": "Retrieve",
"action": "Retrieve Parties",
"apiVersion": "v2"
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/users/get-users"
payload = {
"partyNumber": 789,
"includeBills": True,
"page": {
"size": 50,
"pageNumber": 0
},
"method": "Retrieve",
"action": "Retrieve Parties",
"apiVersion": "v2"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partyNumber: 789,
includeBills: true,
page: {size: 50, pageNumber: 0},
method: 'Retrieve',
action: 'Retrieve Parties',
apiVersion: 'v2'
})
};
fetch('https://{workspace}.spreesuite.com/billspree/users/get-users', 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://{workspace}.spreesuite.com/billspree/users/get-users",
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([
'partyNumber' => 789,
'includeBills' => true,
'page' => [
'size' => 50,
'pageNumber' => 0
],
'method' => 'Retrieve',
'action' => 'Retrieve Parties',
'apiVersion' => 'v2'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{workspace}.spreesuite.com/billspree/users/get-users"
payload := strings.NewReader("{\n \"partyNumber\": 789,\n \"includeBills\": true,\n \"page\": {\n \"size\": 50,\n \"pageNumber\": 0\n },\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Parties\",\n \"apiVersion\": \"v2\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://{workspace}.spreesuite.com/billspree/users/get-users")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partyNumber\": 789,\n \"includeBills\": true,\n \"page\": {\n \"size\": 50,\n \"pageNumber\": 0\n },\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Parties\",\n \"apiVersion\": \"v2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/users/get-users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partyNumber\": 789,\n \"includeBills\": true,\n \"page\": {\n \"size\": 50,\n \"pageNumber\": 0\n },\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Parties\",\n \"apiVersion\": \"v2\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {
"user": {
"partyID": 789,
"partyNumber": 789,
"name": "Jane Doe",
"walletAccount": {
"balance": 0
},
"outstandingAccount": {
"balance": 0
},
"userAccount": {
"status": "ACTIVE"
},
"subscriptionGroups": [],
"subscriptions": []
}
}
}Parties
View Party
Retrieves full party detail, including bills (when includeBills is true), wallet and outstanding balances, competencies, and Billing Accounts/Subscriptions.
POST
/
billspree
/
users
/
get-users
View Party
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/users/get-users \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"partyNumber": 789,
"includeBills": true,
"page": {
"size": 50,
"pageNumber": 0
},
"method": "Retrieve",
"action": "Retrieve Parties",
"apiVersion": "v2"
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/users/get-users"
payload = {
"partyNumber": 789,
"includeBills": True,
"page": {
"size": 50,
"pageNumber": 0
},
"method": "Retrieve",
"action": "Retrieve Parties",
"apiVersion": "v2"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partyNumber: 789,
includeBills: true,
page: {size: 50, pageNumber: 0},
method: 'Retrieve',
action: 'Retrieve Parties',
apiVersion: 'v2'
})
};
fetch('https://{workspace}.spreesuite.com/billspree/users/get-users', 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://{workspace}.spreesuite.com/billspree/users/get-users",
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([
'partyNumber' => 789,
'includeBills' => true,
'page' => [
'size' => 50,
'pageNumber' => 0
],
'method' => 'Retrieve',
'action' => 'Retrieve Parties',
'apiVersion' => 'v2'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{workspace}.spreesuite.com/billspree/users/get-users"
payload := strings.NewReader("{\n \"partyNumber\": 789,\n \"includeBills\": true,\n \"page\": {\n \"size\": 50,\n \"pageNumber\": 0\n },\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Parties\",\n \"apiVersion\": \"v2\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://{workspace}.spreesuite.com/billspree/users/get-users")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partyNumber\": 789,\n \"includeBills\": true,\n \"page\": {\n \"size\": 50,\n \"pageNumber\": 0\n },\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Parties\",\n \"apiVersion\": \"v2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/users/get-users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partyNumber\": 789,\n \"includeBills\": true,\n \"page\": {\n \"size\": 50,\n \"pageNumber\": 0\n },\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Parties\",\n \"apiVersion\": \"v2\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {
"user": {
"partyID": 789,
"partyNumber": 789,
"name": "Jane Doe",
"walletAccount": {
"balance": 0
},
"outstandingAccount": {
"balance": 0
},
"userAccount": {
"status": "ACTIVE"
},
"subscriptionGroups": [],
"subscriptions": []
}
}
}Authorizations
Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)
Body
application/json
Was this page helpful?
⌘I
