Get Organization list

Retrieve Organization list.

The list contains only Organizations the current authenticated user is part of.

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.

Required range: 0 <= x <= 0

Example:

0

messages

any[]

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

Example:

[]

total

number

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

Required range: x >= 0

Example:

20

data

object[]

Show child attributes

data.id

number

Unique identifier for the Organization.

Example:

5

data.name

string

Organization common name.

Example:

"Sample Organization"

data.description

string

Short description of the Organization.

Example:

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

data.ips

string[]

Organization public IPs.

Public IPv4 address.

data.logo

string

Organization logo URL.

Example:

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

data.domains

string[]

Organization owned domains.

data.website

string

Organization main website.

Example:

"https://sample.com"

data.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

data.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

data.infrastructure

enum<string>

Organization infrastructure in-use.

Available options:

cloud,

on-prem,

hybrid

data.number_employees

number

The number of employees currently in organization.

Example:

10

data.contacts

object[]

Points of contact for the Organization.

Show child attributes

data.contacts.name

string

Name of the contact.

Example:

"John Doe"

data.contacts.role

string

Role of the contact.

Example:

"Supervisor"

data.contacts.email

string

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

Example:

"[e-mail]"

data.contacts.phone

string

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

Example:

"3333333333"

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.

Example:

true