Your platforms

What platforms.list does

platforms.list names every platform switched on for you, and says how much of it crm covers. It takes nothing.

const { platforms } = await appnigma.platforms.list();
for (const { platform, label, support, coverage } of platforms) {
  console.log(platform, label, support, coverage);
}

client.platforms.list[:platforms].each do |platform|
  puts "#{platform[:label]}: #{platform[:support]}"
end

for platform in client.platforms.list()["platforms"]:
    print(platform["label"], platform["support"])

What you get back

Each entry in platforms has:

platformstring

The platform key, such as hubspot. Pass it as platform to the other calls.

labelstring

The platform's name, as people know it.

supportstring

One of:

supported: crm answers in the shared shapes for every object and action coverage lists.
experimental: there is no adapter yet. request and run work, and crm answers DATA_TYPE_NOT_AVAILABLE. There is no support promise for it.
unknown: we could not check just now. Ask again in a minute.

coveragearray or null

For a supported platform, each object and the actions crm has for it, such as [{ object: "contact", actions: ["list", "get"] }]. An empty list for an experimental one. Empty when support is unknown: null in TypeScript, nil in Ruby, None in Python.

When we ship an adapter for a platform you already use, it becomes supported with nothing to change on your side. To ask for a platform we do not offer yet, tell us in your Slack channel with us.

What platforms.list does

What you get back

On this page