List Organizations
Intent
Reads the available organizations as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect organizations. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries organizations:read or organizations:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
List organizations.
Scopes: organizations:read organizations:write
curl --request GET \
--url https://api.getruba.com/v1/organizations/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getruba.com/v1/organizations/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getruba.com/v1/organizations/', 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.getruba.com/v1/organizations/",
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://api.getruba.com/v1/organizations/"
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://api.getruba.com/v1/organizations/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getruba.com/v1/organizations/")
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{
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"avatar_url": "<string>",
"proration_behavior": "invoice",
"allow_customer_updates": true,
"email": "<string>",
"website": "<string>",
"socials": [
{
"platform": "x",
"url": "<string>"
}
],
"status": "created",
"details_submitted_at": "2023-11-07T05:31:56Z",
"default_presentment_currency": "<string>",
"default_tax_behavior": "location",
"feature_settings": {
"issue_funding_enabled": false,
"seat_based_pricing_enabled": false,
"wallets_enabled": false,
"member_model_enabled": false,
"checkout_localization_enabled": false,
"overview_metrics": [
"<string>"
],
"reset_proration_behavior_enabled": false,
"off_session_charges_enabled": false,
"slack_benefit_enabled": false,
"preview_access_enabled": false,
"disputes_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"proration_behavior": "invoice",
"benefit_revocation_grace_period": 123,
"prevent_trial_abuse": true,
"allow_customer_updates": true
},
"customer_email_settings": {
"order_confirmation": true,
"subscription_cancellation": true,
"subscription_confirmation": true,
"subscription_cycled": true,
"subscription_cycled_after_trial": true,
"subscription_past_due": true,
"subscription_renewal_reminder": true,
"subscription_revoked": true,
"subscription_trial_conversion_reminder": true,
"subscription_uncanceled": true,
"subscription_updated": true
},
"customer_portal_settings": {
"usage": {
"show": true
},
"subscription": {
"update_seats": true,
"update_plan": true
},
"customer": {
"allow_email_change": true
}
},
"account_id": "<string>",
"payout_account_id": "<string>",
"capabilities": {
"checkout_payments": true,
"subscription_renewals": true,
"payouts": true,
"refunds": true,
"api_access": true,
"dashboard_access": true
},
"country": "AD"
}
],
"pagination": {
"total_count": 123,
"max_page": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
You can generate an Organization Access Token from your organization's settings.
Query Parameters
Filter by slug.
Page number, defaults to 1.
Size of a page, defaults to 10. Maximum is 100.
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
created_at, -created_at, slug, -slug, name, -name, next_review_threshold, -next_review_threshold, days_in_status, -days_in_status curl --request GET \
--url https://api.getruba.com/v1/organizations/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getruba.com/v1/organizations/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getruba.com/v1/organizations/', 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.getruba.com/v1/organizations/",
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://api.getruba.com/v1/organizations/"
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://api.getruba.com/v1/organizations/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getruba.com/v1/organizations/")
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{
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"avatar_url": "<string>",
"proration_behavior": "invoice",
"allow_customer_updates": true,
"email": "<string>",
"website": "<string>",
"socials": [
{
"platform": "x",
"url": "<string>"
}
],
"status": "created",
"details_submitted_at": "2023-11-07T05:31:56Z",
"default_presentment_currency": "<string>",
"default_tax_behavior": "location",
"feature_settings": {
"issue_funding_enabled": false,
"seat_based_pricing_enabled": false,
"wallets_enabled": false,
"member_model_enabled": false,
"checkout_localization_enabled": false,
"overview_metrics": [
"<string>"
],
"reset_proration_behavior_enabled": false,
"off_session_charges_enabled": false,
"slack_benefit_enabled": false,
"preview_access_enabled": false,
"disputes_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"proration_behavior": "invoice",
"benefit_revocation_grace_period": 123,
"prevent_trial_abuse": true,
"allow_customer_updates": true
},
"customer_email_settings": {
"order_confirmation": true,
"subscription_cancellation": true,
"subscription_confirmation": true,
"subscription_cycled": true,
"subscription_cycled_after_trial": true,
"subscription_past_due": true,
"subscription_renewal_reminder": true,
"subscription_revoked": true,
"subscription_trial_conversion_reminder": true,
"subscription_uncanceled": true,
"subscription_updated": true
},
"customer_portal_settings": {
"usage": {
"show": true
},
"subscription": {
"update_seats": true,
"update_plan": true
},
"customer": {
"allow_email_change": true
}
},
"account_id": "<string>",
"payout_account_id": "<string>",
"capabilities": {
"checkout_payments": true,
"subscription_renewals": true,
"payouts": true,
"refunds": true,
"api_access": true,
"dashboard_access": true
},
"country": "AD"
}
],
"pagination": {
"total_count": 123,
"max_page": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}