User Service
Proxy GET requests to User Service
Proxies GET requests to the User Service
get/user-service/{path}
Request
- Base URLhttps://api.firefly.ai/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
pathstring required
The path to proxy to the user service
Query parameters
searchstring
Search users by name or email using full-text search
type'USER' | 'SA' | 'TEAM'
Filter by user type - either regular USER or Service Account (SA)
role_idsstring[]
Filter by role IDs - users must have at least one of these roles
team_idsstring[]
Filter by team IDs - users must be members of at least one of these teams
limitinteger
Maximum number of users to return
offsetinteger
Number of users to skip
pageSizeinteger
Alternative to limit - maximum number of items per page
pageinteger
Page number for pagination
sortstring
Sort parameter
filter_by_emailstring
Filter by email
filter_by_rolestring
Filter by role
emailstring
Filter by email
user_idstring
Filter by user ID
team_idstring
Filter by team ID
Response
Successful response from user service
object required
Changes
No recorded changes to this operation across all 1 revision of this API.