GET
/
api
/
v1
/
search
cURL
curl --request GET \
  --url https://app.aegister.com/api/v1/search \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": [],
  "total": 20,
  "data": [
    {
      "type": "organization",
      "extra": {
        "id": 1,
        "title": "Sample Organization",
        "value": "/organizations/edit/1",
        "logo": "https://sample.com/logo.svg"
      }
    }
  ]
}

Authorizations

​
X-Aegister-Token
string
header
required

Query Parameters

​
keyword
string

Keyword for item search

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

0

​
messages
any[]

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

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