List communication profiles

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communicationProfiles.getSettingsCommunicationProfiles({limit: 20});
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.communication_profiles.communication_profiles_dto.CommunicationProfilesDto.SettingsCommunicationProfileList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsCommunicationProfileList> response = client.communicationProfiles().getSettingsCommunicationProfiles(
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

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

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communicationProfiles
    .getSettingsCommunicationProfiles(queryParams: {'limit': 20});
print(response.map);

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.CommunicationProfiles().GetSettingsCommunicationProfiles(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>"
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

GET

settings

communication_profiles

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communicationProfiles.getSettingsCommunicationProfiles({limit: 20});
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.communication_profiles.communication_profiles_dto.CommunicationProfilesDto.SettingsCommunicationProfileList;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsCommunicationProfileList> response = client.communicationProfiles().getSettingsCommunicationProfiles(
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

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

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communicationProfiles
    .getSettingsCommunicationProfiles(queryParams: {'limit': 20});
print(response.map);

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.CommunicationProfiles().GetSettingsCommunicationProfiles(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>"
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Returns the profiles under data, with pagination for the next page. To filter, add filter_<field>=<value>.

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 most communication profiles to return on one page.

Example:

20

cursor

string

The pagination.next_cursor from the previous page, to fetch the next page.

sort

string

The field to sort by, such as created_on. Prefix it with - for descending order, as in -created_on.

Response

200 - application/json

One page of communication profiles.

data

object[]

Show child attributes

object

string

pagination

object

Show child attributes

url

string

Guides

API reference

Authorizations

Query Parameters

Response