Get Organization list

Authorizations

X-Aegister-Token

string

header

required

Query Parameters

editable

boolean

Filter organizations that authenticated user can edit.

industries[]

string[]

Filter organizations by industry.

limit

number

default:50

Max number of reponse items.

name

string

Filter by organization name.
Checks if Organization's name contains this value.
This filter is case insensitive.

offset

number

default:0

Offset response items.

order

string

default:-id

Order results by item field.

owned

boolean

Filter organizations that authenticated user owns.

sectors[]

string[]

Filter organizations by sector.

Response

200 - application/json

error

integer

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

Intervallo richiesto: 0 <= x <= 0

messages

array

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

total

number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Intervallo richiesto: x >= 0

data

object[]

Mostra attributi figli

data.id

number

Unique identifier for the Organization.

data.name

string

Organization common name.

data.description

string

Short description of the Organization.

data.ips

string<ipv4>[]

Organization public IPs.

Public IPv4 address.

data.logo

string<uri>

Organization logo URL.

data.domains

string<hostname>[]

Organization owned domains.

data.website

string<uri>

Organization main website.

data.sectors

enum<string>[]

Sectors in which the Organization operates.

Opzioni disponibili:

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

data.industries

enum<string>[]

Industries in which the Organization operates.

Opzioni disponibili:

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

data.infrastructure

enum<string>

Organization infrastructure in-use.

Opzioni disponibili:

cloud,

on-prem,

hybrid

data.number_employees

number

The number of employees currently in organization.

data.contacts

object[]

Points of contact for the Organization.

Mostra attributi figli

data.contacts.name

string

Name of the contact.

data.contacts.role

string

Role of the contact.

data.contacts.email

string<email>

Email address of the contact.
Ensure to set this if phone is empty.

data.contacts.phone

string

Phone number of the contact.
Ensure to set this if email is empty.

data.contacts.email_report

boolean

If true then will receive automatic emails each week with a report.
If set true, ensure email value is not empty.

API Documentation

Endpoints

Authorizations

Query Parameters

Response