GETUser

/user/search

Searches for users

Base URL

https://<tenant>.dieagenturverwaltung.de/api/v2

Required Security

ApiKeyAuth (Authorization: Session Token)

Produces

application/json

Request

Query Parameters

Name	Type	Required	Description
deleted	boolean	No	Search only deleted users
q	string	No	The filter, minimum 2 characters
page	integer	No	The page
page_size	integer	No	The page size

cURL

curl -X GET 'https://<tenant>.dieagenturverwaltung.de/api/v2/user/search?deleted=true&q=string' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token'

Responses

200OK

rest_models.PageResponse-app_SmallUserapplication/json

Example

{
  "collection": [
    {...}
  ],
  "count": 123,
  "page": 123,
  "page_size": 123
}

400Bad Request

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}

404Not Found

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}

500Internal Server Error

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}