Search Users

Search users.

Endpoint

GET /api/v1/search

Parameters

Query parameters

Parameter	Type	Required	Description
filter	string	yes	Type of the active filter. Only users is allowed.
query	string	yes	Your search query to find users

Request example

cURL

curl --location --request GET 'https://files.ro/api/v1/search?filter=users&query=john@doe.com' \
--header 'Authorization: Bearer {token}'

Response

200 OK

{
  "data": [
    {
      "data": {
        "id": "user_123",
        "type": "user",
        "attributes": {
          "avatar": "https://files.ro/storage/avatars/jane.png",
          "name": "Jane Doe",
          "color": "#00BC7E",
          "email": "jane@example.com"
        }
      }
    }
  ]
}

401 Unauthorized

{
  "type": "error",
  "message": "You are not authorized"
}

403 Forbidden

{
  "type": "error",
  "message": "Access denied. You need administrator privileges to search the users."
}

422 Unprocessable Entity

{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is required."
    ]
  }
}