POST
/
api
/
v1
/
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": [
    "Agriculture"
  ],
  "industries": [
    "Accounting"
  ],
  "infrastructure": "cloud",
  "contacts": [
    {
      "name": "John Doe",
      "role": "Supervisor",
      "email": "jdoe@mail.com",
      "phone": "3333333333",
      "email_report": true
    }
  ],
  "domains": [
    "sample.com"
  ],
  "ips": [
    "11.22.33.44"
  ]
}'
{
  "error": 0,
  "messages": [],
  "organization": 123
}

Authorizations

​
X-Aegister-Token
string
header
required

Body

​
name
string

Organization common name.

Examples:

"Sample Organization"

"My Organization"

​
description
string

Organization description

Examples:

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

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.

​
industries
enum<string>[]

Industries in which the Organization operates.

​
infrastructure
enum<string>

Organization infrastructure in-use.

Available options:
cloud,
on-prem,
hybrid
​
contacts
object[]

Points of contact for the Organization.

​
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
Examples:

0

​
messages
any[]

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

Examples:
[]
​
organization
number

Organization id of the newly created one.