List child organisations

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/organisations?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.organisations().getSettingsOrganisations(Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Organisations.GetSettingsOrganisationsAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Organisations().GetSettingsOrganisations(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

GET

settings

organisations

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/organisations?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.organisations().getSettingsOrganisations(Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Organisations.GetSettingsOrganisationsAsync(new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Organisations().GetSettingsOrganisations(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Records are under data, and the listing pages by cursor. The root organisation is not in this list; read it with GET /settings/organisation. Other fields filter as filter_<field>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit

integer

The number of records per page.

Example:

20

cursor

string

The next_cursor from the previous page, to read the next page.

sort

string

The field to sort by; prefix it with - for descending order.

Response

200

One page of child organisations, under data, with pagination.

Guides

API reference

Authorizations

Query Parameters

Response