Get instance communication settings | Clerk API (unofficial showcase)

1 status code

200Success

objectstringrequired

Allowed:instance_communication

blocked_country_codesarray<string>required

ISO 3166-1 alpha-2 country codes that are blocked for SMS delivery on this instance. Codes that aren't recognized are silently dropped.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.communication.list();

{
  "object": "instance_communication",
  "blocked_country_codes": [
    42
  ]
}