TTWrite API: Search People
Endpoint URL
//ttwrite.4up.eu/mobile_api/search_people
Description
This API allows users to search for people on the TTWrite platform by name or username, facilitating user discovery.
Parameters
Field | Value | Remarks |
---|---|---|
query | string | The search term, such as a name or username, for finding people. |
limit | integer | Optional. The number of results to return. Default is 20. |
offset | integer | Optional. Pagination starting point for the results. |
Example Usage
codeGET //ttwrite.4up.eu/mobile_api/search_people?query=JohnDoe&limit=10&offset=0
Notes
- Authentication is required to access this API.
- The
query
parameter is mandatory and is used to filter users based on their names or usernames. - Use the
limit
andoffset
parameters to paginate through large result sets.