> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userecord.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search places in India

> Type-ahead for a job’s place in India: matches the start of district and place names (up to 8 districts and 25 places). Use the place `name` as `location.city` and its `state` as `location.state`. For a job abroad use `GET /countries`.

**Scope:** `mandates:read` or `mandates:write`



## OpenAPI

````yaml /blue-collar-api/api-reference/openapi.json get /locations
openapi: 3.1.0
info:
  title: Record Blue Collar API
  version: 1.0.0
  description: >-
    Run Record candidate verification from your own system. You need two things:
    your **key id** and your **secret**. Everything else is generated. See
    Authentication for how.
servers:
  - url: https://api-bc.userecord.io/api/v1/partner
    description: Blue Collar API
security: []
tags:
  - name: Skills
    description: The skill taxonomy, read live a page at a time
  - name: Skill requests
    description: Ask Record to add a missing skill
  - name: Lookups
    description: >-
      Lookups for filling in a job mandate: places in India, the countries an
      abroad job can be in, and the employment types and shifts the playground
      offers
  - name: Workflows
    description: >-
      Your organisation's blue-collar workflows (read all; change and
      soft-delete only the ones you created)
  - name: Job mandates
    description: >-
      Your organisation's job mandates, addressed by Record's mandate_id (read
      all; change only the ones you created)
  - name: Campaigns
    description: Contact candidates for one of your jobs and verify them. Spends credits
  - name: Results
    description: >-
      What Record collected from each candidate: status (pending, completed,
      declined, failed) and an output of answers and verdicts
  - name: Events
    description: >-
      Pull your result events and acknowledge them: the safety net behind the
      webhook, and a way to receive results without exposing a URL
  - name: Webhooks
    description: >-
      Endpoints that Record POSTs result events to: signed, retried until you
      acknowledge, replayable
  - name: Analytics
    description: >-
      The workflow Overview analytics of the Record playground: funnel,
      channels, follow-ups, calls, drop-offs, languages (read-only, scope
      analytics:read)
paths:
  /locations:
    get:
      tags:
        - Lookups
      summary: Search places in India
      description: >-
        Type-ahead for a job’s place in India: matches the start of district and
        place names (up to 8 districts and 25 places). Use the place `name` as
        `location.city` and its `state` as `location.state`. For a job abroad
        use `GET /countries`.


        **Scope:** `mandates:read` or `mandates:write`
      operationId: searchLocations
      parameters:
        - name: q
          in: query
          required: true
          description: 2 to 60 characters; matches the start of a district or place name
          schema:
            type: string
            minLength: 2
            maxLength: 60
          example: coim
      responses:
        '200':
          description: Matching districts and places
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      query:
                        type: string
                      districts:
                        type: array
                        items:
                          type: object
                          properties:
                            location_id:
                              type: string
                            name:
                              type: string
                            state:
                              anyOf:
                                - type: string
                                - type: 'null'
                      places:
                        type: array
                        items:
                          type: object
                          properties:
                            location_id:
                              type: string
                            name:
                              type: string
                              description: Use as `location.city`
                            district:
                              anyOf:
                                - type: string
                                - type: 'null'
                            state:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: Use as `location.state`
              example:
                success: true
                data:
                  query: coim
                  districts:
                    - location_id: D_TN_COIMBATORE
                      name: Coimbatore
                      state: Tamil Nadu
                  places:
                    - location_id: P_0412873
                      name: Coimbatore
                      district: Coimbatore
                      state: Tamil Nadu
        '400':
          description: >-
            `VALIDATION_FAILED`: `q` missing, shorter than 2 or longer than 60
            characters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: pcall GET "/api/v1/partner/locations?q=coim"
        - lang: javascript
          label: JavaScript
          source: |-
            const res = await call("GET", "/api/v1/partner/locations?q=coim");
            const { data } = await res.json();
        - lang: python
          label: Python
          source: |-
            res = call("GET", "/api/v1/partner/locations?q=coim")
            data = res.json()["data"]
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          const: false
          type: boolean
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - LIMIT_EXCEEDED
                - UNAUTHORIZED
                - SCOPE_MISSING
                - FORBIDDEN
                - HTTPS_REQUIRED
                - NOT_FOUND
                - CONFLICT
                - WORKFLOW_IN_USE
                - INSUFFICIENT_CREDITS
                - IDEMPOTENCY_KEY_REQUIRED
                - IDEMPOTENCY_KEY_REUSED
                - IDEMPOTENCY_IN_PROGRESS
                - PAYLOAD_TOO_LARGE
                - UNSUPPORTED_MEDIA_TYPE
                - RATE_LIMITED
                - COOLDOWN
                - DAILY_CAP
                - SERVICE_DISABLED
                - SERVER_ERROR
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
            request_id:
              type: string
              description: Quote it to Record support
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request.
    SecretKey:
      type: apiKey
      in: header
      name: x-secret-key
      description: >-
        Your secret, `VFN_SK_…`. **Not a real header, and never sent to the
        API.** It is only a form field for Try it, which uses it to sign your
        request in your browser. In your own code you sign each request with the
        secret and send `x-api-key`, `x-timestamp` and `x-signature` (see
        Authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.