Skip to main content
GET
/
api
/
v1
/
user
/
search
curl --request GET \
    --url "http://localhost:8000/api/v1/user/search?q=john" \
    --header "Authorization: Bearer <your_access_token>" \
    | jq

{
  "data": [
    {
      "name": "<string>",
      "email": "jsmith@example.com",
      "account": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roles": "user",
      "is_active": true,
      "is_verified": true,
      "is_superuser": false,
      "bio": "<string>",
      "dob": "2023-12-25",
      "phone": "<string>",
      "avatar_photo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deleted_at": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}
curl --request GET \
    --url "http://localhost:8000/api/v1/user/search?q=john" \
    --header "Authorization: Bearer <your_access_token>" \
    | jq

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
q
string
required
Minimum string length: 2
​
skip
integer
default:0
​
limit
integer
default:20

Response

Successful Response

Schema for paginated user list.

​
data
UserPublic · object[]
required
​
count
integer
required