GET

api

account-suggestions

organization-ids

preview

Preview Accounts From an Organization ID

curl --request GET \
  --url https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview', 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.sequenzy.com/api/v1/account-suggestions/organization-ids/preview",
  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.sequenzy.com/api/v1/account-suggestions/organization-ids/preview"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview")

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

{
  "success": true,
  "organizations": [
    {
      "externalId": "zplgaplihqncouqlmqf8os3e",
      "name": "Leadpages",
      "domain": "leadpages.com",
      "contactCount": 14,
      "sampleEmails": [
        "henny@leadpages.com",
        "nicola@leadpages.com",
        "corah@leadpages.com"
      ]
    }
  ]
}

{ "success": false, "error": "`propertyKey` cannot be blank." }

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "No company selected" }

{ "success": false, "error": "Expected property 'propertyKey' to be string" }

Preview Accounts From an Organization ID

Shows the biggest organizations that creating accounts from propertyKey would make: the name each account would get, how many contacts would join it, and a few of those contacts. Nothing is created. Each account is named from nameKey when you pass one. Otherwise it is named after the work email domain most of its contacts share, so organization_id: zplgap... with contacts at leadpages.com becomes Leadpages. Personal and disposable providers, such as gmail.com, and your own sending domains are ignored. A domain needs most of the organization’s contacts, so one consultant among personal emails does not name it. When no name can be found, name is null and the account shows its ID. Accounts that already exist keep their current name and domain, and contactCount can include contacts that were deleted since, which are skipped when creating. Requires the subscribers:read scope.

Request

string

required

Event property or contact attribute holding your organization ID, from Detect Organization IDs.

string

default:"event"

event for an event property, attribute for a contact attribute.

string

Property or attribute holding the organization name.

number

default:"5"

Organizations to return, biggest first. Values outside 1 to 50 are clamped, and non-numeric values use the default.

curl "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview?propertyKey=organization_id" \
  -H "Authorization: Bearer API_KEY"

Response

array

The biggest organizations first.

Show properties

string

The organization ID, which becomes the account’s external ID.

string | null

The name the account gets, or null when none can be found.

string | null

The work email domain most of its contacts share.

number

Contacts that would become members.

string[]

Up to 3 of those contacts, those at domain first.

{
  "success": true,
  "organizations": [
    {
      "externalId": "zplgaplihqncouqlmqf8os3e",
      "name": "Leadpages",
      "domain": "leadpages.com",
      "contactCount": 14,
      "sampleEmails": [
        "henny@leadpages.com",
        "nicola@leadpages.com",
        "corah@leadpages.com"
      ]
    }
  ]
}

{ "success": false, "error": "`propertyKey` cannot be blank." }

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "No company selected" }

{ "success": false, "error": "Expected property 'propertyKey' to be string" }

Preview Accounts From an Organization ID

curl --request GET \
  --url https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview', 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.sequenzy.com/api/v1/account-suggestions/organization-ids/preview",
  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.sequenzy.com/api/v1/account-suggestions/organization-ids/preview"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/account-suggestions/organization-ids/preview")

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

{
  "success": true,
  "organizations": [
    {
      "externalId": "zplgaplihqncouqlmqf8os3e",
      "name": "Leadpages",
      "domain": "leadpages.com",
      "contactCount": 14,
      "sampleEmails": [
        "henny@leadpages.com",
        "nicola@leadpages.com",
        "corah@leadpages.com"
      ]
    }
  ]
}

{ "success": false, "error": "`propertyKey` cannot be blank." }

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "No company selected" }

{ "success": false, "error": "Expected property 'propertyKey' to be string" }

​Preview Accounts From an Organization ID

​Request

​Response

Preview Accounts From an Organization ID

Request

Response