Get Organization list

Retrieve Organization list.

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

GET /api/v1/organizations

cURL

cURL

curl --request GET \
  --url https://app.aegister.com/api/v1/organizations \
  --header 'X-Aegister-Token: <api-key>'

import requests

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

headers = {"X-Aegister-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Aegister-Token': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Aegister-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.aegister.com/api/v1/organizations")
  .header("X-Aegister-Token", "<api-key>")
  .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::Get.new(url)
request["X-Aegister-Token"] = '<api-key>'

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

200

{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "ips": [
        "127.0.0.1"
      ],
      "logo": "<string>",
      "domains": [
        "<string>"
      ],
      "website": "<string>",
      "sectors": [],
      "industries": [],
      "number_employees": 123,
      "contacts": [
        {
          "name": "<string>",
          "role": "<string>",
          "email": "[e-mail]",
          "phone": "<string>",
          "email_report": true
        }
      ]
    }
  ]
}

Authorizations

ApiKeyAuthApiKeyQueryParam

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 · array

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

Examples:

20

30

40

data · object[]

Show child attributes