API reference · Lookups

Discover job families and allowed filter values

GEThttps://trawle.com/v1/taxonomy

Static family slugs and fixed enums from the same bundled taxonomy and JobQuery schema used by search. Use GET /v1/families when live open-job counts are needed. No database or model calls.

Authentication

Header x-api-key: Read-only API key from https://trawle.com/account#api-keys. 1,000 requests per daily window. Anonymous requests are also supported with a per-IP limit.

200Families and filter values.SearchOptions
  • familiesarray<object> · TaxonomyFamilyrequired
    3 propertiesper item
    • slugstringrequired
    • namestringrequired
    • descriptionstringrequired
  • filtersobjectrequired
    9 properties
    • seniorityarray<string>required
      One of
      internentrymidseniorleadprincipaldirectorvpexecutive
    • employmentarray<string>required
      One of
      full_timepart_timecontracttemporaryinternshipapprenticeshipseasonalvolunteer
    • workplacearray<string>required
      One of
      remotehybridonsite
    • postedarray<string>required
      One of
      1d3d7d30d
    • sortarray<string>required
      One of
      newestpay
    • currencyarray<string>required
      One of
      USDEURGBPDKKSEKNOKCHFCADAUD
    • payarray<string>required
      One of
      listed
    • repostsarray<string>required
      One of
      hideonly
    • agenciesarray<string>required
      One of
      includeonly
401Invalid, expired or revoked API key.Error
  • errorobjectrequired
    4 properties
    • codestringrequired

      Machine-readable: invalid_request, not_found, forbidden, rate_limited, internal.

      Example
      invalid_request
    • messagestringrequired
      Example
      places: expected an array of GeoNames ids
    • hintstringoptional

      What to do next, e.g. which lookup to call first.

      Example
      Resolve place names to ids with GET /v1/places?q=
    • issuesarray<object>optional

      Validation problems, one per invalid field.

      2 propertiesper item
      • pathstringrequired
      • messagestringrequired
429Rate limit reached. Respect Retry-After and cache results.Error
  • errorobjectrequired
    4 properties
    • codestringrequired

      Machine-readable: invalid_request, not_found, forbidden, rate_limited, internal.

      Example
      invalid_request
    • messagestringrequired
      Example
      places: expected an array of GeoNames ids
    • hintstringoptional

      What to do next, e.g. which lookup to call first.

      Example
      Resolve place names to ids with GET /v1/places?q=
    • issuesarray<object>optional

      Validation problems, one per invalid field.

      2 propertiesper item
      • pathstringrequired
      • messagestringrequired