Customer groups
Get customer group
GET
/
customer_groups
/
{uuid}
Get customer group
curl --request GET \
--url https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid} \
--header 'X-Api-Key: <api-key>' \
--header 'X-App-Id: <api-key>'const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};
fetch('https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}"
headers = {
"X-App-Id": "<api-key>",
"X-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"customer_group": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"net_terms": 0,
"net_terms_label": "<string>",
"number_of_customers": 123,
"total_open_balance_amount": 123,
"statement_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"customers": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>"
}
]
}
}Authorizations
App ID for authentication
API Key for authentication
Path Parameters
Response
Successful operation
Group fields with inline customers array. Returned by show, create, and update.
Show child attributes
Show child attributes
⌘I
Get customer group
curl --request GET \
--url https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid} \
--header 'X-Api-Key: <api-key>' \
--header 'X-App-Id: <api-key>'const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};
fetch('https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}"
headers = {
"X-App-Id": "<api-key>",
"X-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"customer_group": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"net_terms": 0,
"net_terms_label": "<string>",
"number_of_customers": 123,
"total_open_balance_amount": 123,
"statement_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"customers": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>"
}
]
}
}