GET
/
api
/
v1
/
organizations
curl --request GET \
  --url https://app.aegister.com/api/v1/organizations \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": [],
  "total": 20,
  "data": [
    {
      "id": 5,
      "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.",
      "ips": [
        "11.22.33.44"
      ],
      "logo": "https://sample.com/logo.svg",
      "domains": [
        "sample.com"
      ],
      "website": "https://sample.com",
      "sectors": [
        "Agriculture"
      ],
      "industries": [
        "Accounting"
      ],
      "infrastructure": "cloud",
      "number_employees": 10,
      "contacts": [
        {
          "name": "John Doe",
          "role": "Supervisor",
          "email": "jdoe@mail.com",
          "phone": "3333333333",
          "email_report": true
        }
      ]
    }
  ]
}

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

The response is of type object.

GET
/
api
/
v1
/
organizations
curl --request GET \
  --url https://app.aegister.com/api/v1/organizations \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": [],
  "total": 20,
  "data": [
    {
      "id": 5,
      "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.",
      "ips": [
        "11.22.33.44"
      ],
      "logo": "https://sample.com/logo.svg",
      "domains": [
        "sample.com"
      ],
      "website": "https://sample.com",
      "sectors": [
        "Agriculture"
      ],
      "industries": [
        "Accounting"
      ],
      "infrastructure": "cloud",
      "number_employees": 10,
      "contacts": [
        {
          "name": "John Doe",
          "role": "Supervisor",
          "email": "jdoe@mail.com",
          "phone": "3333333333",
          "email_report": true
        }
      ]
    }
  ]
}

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

The response is of type object.