trawledevelopers
API reference · Lookups

List job families for the families filter

GEThttps://trawle.com/v1/families

Parameters

Query

  • qstringoptional

    Optional name filter.

    Limits
    1 to 100 characters
    Example
    engineering

Responses

200All families, in browsing order.
  • itemsarray<object> · FamilyItemrequired
    3 propertiesper item
    • slugstringrequired
    • namestringrequired
    • openJobsintegerrequired
400Invalid request: see error.issues and error.hint.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
PreviousFind roles for the roles filter