Vai al contenuto principale
GET
/
api
/
v1
/
organizations
cURL
curl --request GET \
  --url https://app.aegister.com/api/v1/organizations \
  --header 'X-Aegister-Token: <api-key>'
{
  "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": [
        "Agriculture"
      ],
      "industries": [
        "Accounting"
      ],
      "infrastructure": "cloud",
      "number_employees": 123,
      "contacts": [
        {
          "name": "<string>",
          "role": "<string>",
          "email": "[email protected]",
          "phone": "<string>",
          "email_report": true
        }
      ]
    }
  ]
}

Autorizzazioni

​
X-Aegister-Token
string
header
obbligatorio

Parametri della query

​
editable
boolean

Filter organizations that authenticated user can edit.

​
industries[]
string[]

Filter organizations by industry.

​
limit
number
predefinito: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
predefinito:0

Offset response items.

​
order
string
predefinito:-id

Order results by item field.

​
owned
boolean

Filter organizations that authenticated user owns.

​
sectors[]
string[]

Filter organizations by sector.

Risposta

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
Esempio:

0

​
messages
array

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

Esempio:
[]
​
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
Esempi:

20

30

40

​
data
object[]