Create Organization

cURL

curl --request POST \
  --url https://app.aegister.com/api/v1/organizations \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "name": "Sample Organization",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
  "number_employees": 10,
  "website": "https://sample.com",
  "logo": "https://sample.com/logo.svg",
  "sectors": [],
  "industries": [],
  "contacts": [
    {
      "name": "John Doe",
      "role": "Supervisor",
      "email": "jdoe@mail.com",
      "phone": "3333333333",
      "email_report": true
    }
  ],
  "domains": [
    "sample.com"
  ],
  "ips": [
    "11.22.33.44"
  ]
}
'

import requests

url = "https://app.aegister.com/api/v1/organizations"

payload = {
    "name": "Sample Organization",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
    "number_employees": 10,
    "website": "https://sample.com",
    "logo": "https://sample.com/logo.svg",
    "sectors": [],
    "industries": [],
    "contacts": [
        {
            "name": "John Doe",
            "role": "Supervisor",
            "email": "jdoe@mail.com",
            "phone": "3333333333",
            "email_report": True
        }
    ],
    "domains": ["sample.com"],
    "ips": ["11.22.33.44"]
}
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Sample Organization',
    description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
    number_employees: 10,
    website: 'https://sample.com',
    logo: 'https://sample.com/logo.svg',
    sectors: [],
    industries: [],
    contacts: [
      {
        name: 'John Doe',
        role: 'Supervisor',
        email: 'jdoe@mail.com',
        phone: '3333333333',
        email_report: true
      }
    ],
    domains: ['sample.com'],
    ips: ['11.22.33.44']
  })
};

fetch('https://app.aegister.com/api/v1/organizations', 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://app.aegister.com/api/v1/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Sample Organization',
    'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
    'number_employees' => 10,
    'website' => 'https://sample.com',
    'logo' => 'https://sample.com/logo.svg',
    'sectors' => [
        
    ],
    'industries' => [
        
    ],
    'contacts' => [
        [
                'name' => 'John Doe',
                'role' => 'Supervisor',
                'email' => 'jdoe@mail.com',
                'phone' => '3333333333',
                'email_report' => true
        ]
    ],
    'domains' => [
        'sample.com'
    ],
    'ips' => [
        '11.22.33.44'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Aegister-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aegister.com/api/v1/organizations"

	payload := strings.NewReader("{\n  \"name\": \"Sample Organization\",\n  \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n  \"number_employees\": 10,\n  \"website\": \"https://sample.com\",\n  \"logo\": \"https://sample.com/logo.svg\",\n  \"sectors\": [],\n  \"industries\": [],\n  \"contacts\": [\n    {\n      \"name\": \"John Doe\",\n      \"role\": \"Supervisor\",\n      \"email\": \"jdoe@mail.com\",\n      \"phone\": \"3333333333\",\n      \"email_report\": true\n    }\n  ],\n  \"domains\": [\n    \"sample.com\"\n  ],\n  \"ips\": [\n    \"11.22.33.44\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Aegister-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/organizations")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sample Organization\",\n  \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n  \"number_employees\": 10,\n  \"website\": \"https://sample.com\",\n  \"logo\": \"https://sample.com/logo.svg\",\n  \"sectors\": [],\n  \"industries\": [],\n  \"contacts\": [\n    {\n      \"name\": \"John Doe\",\n      \"role\": \"Supervisor\",\n      \"email\": \"jdoe@mail.com\",\n      \"phone\": \"3333333333\",\n      \"email_report\": true\n    }\n  ],\n  \"domains\": [\n    \"sample.com\"\n  ],\n  \"ips\": [\n    \"11.22.33.44\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Sample Organization\",\n  \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n  \"number_employees\": 10,\n  \"website\": \"https://sample.com\",\n  \"logo\": \"https://sample.com/logo.svg\",\n  \"sectors\": [],\n  \"industries\": [],\n  \"contacts\": [\n    {\n      \"name\": \"John Doe\",\n      \"role\": \"Supervisor\",\n      \"email\": \"jdoe@mail.com\",\n      \"phone\": \"3333333333\",\n      \"email_report\": true\n    }\n  ],\n  \"domains\": [\n    \"sample.com\"\n  ],\n  \"ips\": [\n    \"11.22.33.44\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "error": 0,
  "messages": [],
  "organization": 123
}

{
  "error": 1,
  "messages": [
    "Invalid data provided"
  ]
}

POST

api

organizations

cURL

curl --request POST \
  --url https://app.aegister.com/api/v1/organizations \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "name": "Sample Organization",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
  "number_employees": 10,
  "website": "https://sample.com",
  "logo": "https://sample.com/logo.svg",
  "sectors": [],
  "industries": [],
  "contacts": [
    {
      "name": "John Doe",
      "role": "Supervisor",
      "email": "jdoe@mail.com",
      "phone": "3333333333",
      "email_report": true
    }
  ],
  "domains": [
    "sample.com"
  ],
  "ips": [
    "11.22.33.44"
  ]
}
'

import requests

url = "https://app.aegister.com/api/v1/organizations"

payload = {
    "name": "Sample Organization",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
    "number_employees": 10,
    "website": "https://sample.com",
    "logo": "https://sample.com/logo.svg",
    "sectors": [],
    "industries": [],
    "contacts": [
        {
            "name": "John Doe",
            "role": "Supervisor",
            "email": "jdoe@mail.com",
            "phone": "3333333333",
            "email_report": True
        }
    ],
    "domains": ["sample.com"],
    "ips": ["11.22.33.44"]
}
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Sample Organization',
    description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
    number_employees: 10,
    website: 'https://sample.com',
    logo: 'https://sample.com/logo.svg',
    sectors: [],
    industries: [],
    contacts: [
      {
        name: 'John Doe',
        role: 'Supervisor',
        email: 'jdoe@mail.com',
        phone: '3333333333',
        email_report: true
      }
    ],
    domains: ['sample.com'],
    ips: ['11.22.33.44']
  })
};

fetch('https://app.aegister.com/api/v1/organizations', 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://app.aegister.com/api/v1/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Sample Organization',
    'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
    'number_employees' => 10,
    'website' => 'https://sample.com',
    'logo' => 'https://sample.com/logo.svg',
    'sectors' => [
        
    ],
    'industries' => [
        
    ],
    'contacts' => [
        [
                'name' => 'John Doe',
                'role' => 'Supervisor',
                'email' => 'jdoe@mail.com',
                'phone' => '3333333333',
                'email_report' => true
        ]
    ],
    'domains' => [
        'sample.com'
    ],
    'ips' => [
        '11.22.33.44'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Aegister-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aegister.com/api/v1/organizations"

	payload := strings.NewReader("{\n  \"name\": \"Sample Organization\",\n  \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n  \"number_employees\": 10,\n  \"website\": \"https://sample.com\",\n  \"logo\": \"https://sample.com/logo.svg\",\n  \"sectors\": [],\n  \"industries\": [],\n  \"contacts\": [\n    {\n      \"name\": \"John Doe\",\n      \"role\": \"Supervisor\",\n      \"email\": \"jdoe@mail.com\",\n      \"phone\": \"3333333333\",\n      \"email_report\": true\n    }\n  ],\n  \"domains\": [\n    \"sample.com\"\n  ],\n  \"ips\": [\n    \"11.22.33.44\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Aegister-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/organizations")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Sample Organization\",\n  \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n  \"number_employees\": 10,\n  \"website\": \"https://sample.com\",\n  \"logo\": \"https://sample.com/logo.svg\",\n  \"sectors\": [],\n  \"industries\": [],\n  \"contacts\": [\n    {\n      \"name\": \"John Doe\",\n      \"role\": \"Supervisor\",\n      \"email\": \"jdoe@mail.com\",\n      \"phone\": \"3333333333\",\n      \"email_report\": true\n    }\n  ],\n  \"domains\": [\n    \"sample.com\"\n  ],\n  \"ips\": [\n    \"11.22.33.44\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Sample Organization\",\n  \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n  \"number_employees\": 10,\n  \"website\": \"https://sample.com\",\n  \"logo\": \"https://sample.com/logo.svg\",\n  \"sectors\": [],\n  \"industries\": [],\n  \"contacts\": [\n    {\n      \"name\": \"John Doe\",\n      \"role\": \"Supervisor\",\n      \"email\": \"jdoe@mail.com\",\n      \"phone\": \"3333333333\",\n      \"email_report\": true\n    }\n  ],\n  \"domains\": [\n    \"sample.com\"\n  ],\n  \"ips\": [\n    \"11.22.33.44\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "error": 0,
  "messages": [],
  "organization": 123
}

{
  "error": 1,
  "messages": [
    "Invalid data provided"
  ]
}

Authorizations

X-Aegister-Token

string

header

required

Body

name

string

Organization common name.

Examples:

"Sample Organization"

"My Organization"

description

string

Organization description

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."

number_employees

number

Organization number of employees

Examples:

10

20

30

website

string

Full URL of the Organization website

Examples:

"https://sample.com"

"https://my.organization.com"

logo

string

Full URL reference to Organization Logo file

Examples:

"https://sample.com/logo.svg"

"https://my.organization.com/logo.png"

sectors

enum<string>[]

Sectors in which the Organization operates.

Available options:

Agriculture,

Arts & Entertainment,

Business Services,

Construction,

Consumer Discretionary,

Consumer Staples,

Education,

Energy,

Financials,

Health Care,

Hospitality & Tourism,

Information Technology,

Manufacturing,

Materials,

Media,

Public Sector,

Real Estate,

Retail,

Science & Technology,

Telecommunications,

Transportation,

Utilities

industries

enum<string>[]

Industries in which the Organization operates.

Available options:

Accounting,

Airlines/Aviation,

Alternative Dispute Resolution,

Alternative Medicine,

Animation,

Apparel/Fashion,

Architecture/Planning,

Arts/Crafts,

Automotive,

Aviation/Aerospace,

Banking/Mortgage,

Biotechnology/Greentech,

Broadcast Media,

Building Materials,

Business Supplies/Equipment,

Capital Markets/Hedge Fund/Private Equity,

Chemicals,

Civic/Social Organization,

Civil Engineering,

Commercial Real Estate,

Computer Games,

Computer Hardware,

Computer Networking,

Computer Software/Engineering,

Computer/Network Security,

Construction,

Consumer Electronics,

Consumer Goods,

Consumer Services,

Cosmetics,

Dairy,

Defense/Space,

Design,

E-Learning,

Education Management,

Electrical/Electronic Manufacturing,

Entertainment/Movie Production,

Environmental Services,

Events Services,

Executive Office,

Facilities Services,

Farming,

Financial Services,

Fine Art,

Fishery,

Food Production,

Food/Beverages,

Fundraising,

Furniture,

Gambling/Casinos,

Glass/Ceramics/Concrete,

Government Administration,

Government Relations,

Graphic Design/Web Design,

Health/Fitness,

Higher Education/Acadamia,

Hospital/Health Care,

Hospitality,

Human Resources/HR,

Import/Export,

Individual/Family Services,

Industrial Automation,

Information Services,

Information Technology/IT,

Insurance,

International Affairs,

International Trade/Development,

Internet,

Investment Banking/Venture,

Investment Management/Hedge Fund/Private Equity,

Judiciary,

Law Enforcement,

Law Practice/Law Firms,

Legal Services,

Legislative Office,

Leisure/Travel,

Library,

Logistics/Procurement,

Luxury Goods/Jewelry,

Machinery,

Management Consulting,

Maritime,

Market Research,

Marketing/Advertising/Sales,

Mechanical or Industrial Engineering,

Media Production,

Medical Equipment,

Medical Practice,

Mental Health Care,

Military Industry,

Mining/Metals,

Motion Pictures/Film,

Museums/Institutions,

Music,

Nanotechnology,

Newspapers/Journalism,

Non-Profit/Volunteering,

Oil/Energy/Solar/Greentech,

Online Publishing,

Other Industry,

Outsourcing/Offshoring,

Package/Freight Delivery,

Packaging/Containers,

Paper/Forest Products,

Performing Arts,

Pharmaceuticals,

Philanthropy,

Photography,

Plastics,

Political Organization,

Primary/Secondary Education,

Printing,

Professional Training,

Program Development,

Public Relations/PR,

Public Safety,

Publishing Industry,

Railroad Manufacture,

Ranching,

Real Estate/Mortgage,

Recreational Facilities/Services,

Religious Institutions,

Renewables/Environment,

Research Industry,

Restaurants,

Retail Industry,

Security/Investigations,

Semiconductors,

Shipbuilding,

Sporting Goods,

Sports,

Staffing/Recruiting,

Supermarkets,

Telecommunications,

Textiles,

Think Tanks,

Tobacco,

Translation/Localization,

Transportation,

Utilities,

Venture Capital/VC,

Veterinary,

Warehousing,

Wholesale,

Wine/Spirits,

Wireless,

Writing/Editing

infrastructure

enum<string>

Organization infrastructure in-use.

Available options:

cloud,

on-prem,

hybrid

contacts

object[]

Points of contact for the Organization.

Show child attributes

domains

string<hostname>[]

Organization owned domains.

ips

string<ipv4>[]

Organization public IPs.

Public IPv4 address.

Response

error

integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

Example:

0

messages

array

If error is 1, contains zero or more details on the error.

Example:

[]

organization

number

Organization id of the newly created one.

API Documentation

Endpoints

Authorizations

Body

Response