API reference · Lookups
Find roles for the roles filter
GET
https://trawle.com/v1/rolesRoles whose name or common job titles match q ("react" finds Frontend Engineer). Use items[].slug in JobQuery.roles.
Query
qstringrequiredRole or job title.
- Limits
- 1 to 100 characters
- Example
frontend
limitintegeroptional- Default
8- Limits
- 1 to 20
200Best matches first.
itemsarray<object> · RoleMatchrequired4 propertiesper item
slugstringrequirednamestringrequiredfamilyany · RefrequiredSame shape as its parent (Ref).
openJobsintegerrequired
400Invalid request: see error.issues and error.hint.Error
errorobjectrequired4 properties
codestringrequiredMachine-readable:
invalid_request,not_found,forbidden,rate_limited,internal.- Example
invalid_request
messagestringrequired- Example
places: expected an array of GeoNames ids
hintstringoptionalWhat to do next, e.g. which lookup to call first.
- Example
Resolve place names to ids with GET /v1/places?q=
issuesarray<object>optionalValidation problems, one per invalid field.
2 propertiesper item
pathstringrequiredmessagestringrequired