Jobs

Find job search locations by name

Changed on

Returns the places whose names match a query, each with the location ID that GET /x/jobs/search takes. No match returns an empty list, free.

get/x/jobs/locations

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/x/jobs/locations
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Query parameters

qstring required

Place name or its start, such as new york. Its alias is query. Xquik's cap is 4,096 characters.

limitinteger

Most places to return. Without it, every match returns. Its aliases are pageSize, count, max_results, maxItems, max_items & per_page.

fieldsstring
Example:id,text,author.username

Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it.

omitstring
Example:entities,media

Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.

Response

Matching places

countinteger required

Places returned, each charged 1 credit.

Example response

{
  "locations": [
    {
      "id": "1720462281849397612",
      "name": "New York, US"
    }
  ],
  "count": 1
}

Changes

  • 245194cd4ea7Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

  • d17988b4a85dRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property const value Ask the user to confirm a payment option before creating checkout. was added for the status

    • info

      removed the Ask the user to confirm a payment option before creating checkout. enum value from the //// response property for the response status

    • info

      removed the Ask the user to top up at /dashboard/account. This key cannot open checkout. enum value from the //// response property for the response status