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

# Locations, developers, property types and statuses

> Returns every lookup list in one call. There is no standalone locations endpoint — this is where locations come from.

Use `filters.location.values[].name` as the lead's `areaOfInterest` and `filters.propertyType.values[].name` as `propertyTypeInterest` so those values resolve instead of landing in `intakeUnresolved`. The UUIDs are the ones accepted by the project list filters.

These lists change rarely — cache them (a daily refresh is plenty) rather than calling per lead, since reference reads share the lead endpoint's rate limit.



## OpenAPI

````yaml /api-reference/openapi.json get /public/projects/filters
openapi: 3.0.3
info:
  title: Provident — Lead Intake API
  version: 1.4.0
  description: >-
    Server-to-server API for pushing leads into the Provident CRM.


    Core endpoints:

    1. `POST /oauth2/token` — exchange client credentials for a bearer token.

    2. `POST /public/leads` — create a CRM lead.

    3. `PUT /public/leads/{id}` — add details you did not have when you created
    it (quiz answers the customer finished afterwards, a budget, an area). Send
    only what changed; phones and emails are appended, never replaced, and the
    lead's stage, status, owner and funnel are not writable.


    Optional read-only reference data, using the same token: locations,
    developers, projects and project statuses. Use them to send values that
    match ours, or to show project content on your own pages. They share the
    lead endpoint's rate limit, so cache them.


    Authentication is OAuth 2.0 Client Credentials; there is no user login. Note
    that the `/v2` prefix is part of the server URL and is mandatory.


    The intake is deliberately forgiving: name-based lookup fields that cannot
    be matched do NOT fail the request — the lead is still created and the
    unmatched values are returned in `intakeUnresolved`.


    The endpoint is not idempotent at the transport level, but intake hygiene
    runs before the lead is created: a second enquiry from the same phone/email
    within the merge window (~24h) is MERGED into the existing lead and returns
    a different, much shorter 201 body — `{ id, merged: true, matchedOn }` —
    with no contactId, intakeUnresolved, needsIntakeReview or createdAt. Always
    branch on `merged` before reading anything else. Enquiries from
    property-portal sources (Property Finder, Bayut, Dubizzle) are exempt and
    never merge. Retry only on network timeouts, 429 and 5xx.
  contact:
    name: Provident API support
servers:
  - url: https://devapi.prov.ae/v2
    description: Staging / development — build and test here
  - url: https://prodapi.prov.ae/v2
    description: Production — live leads
security: []
tags:
  - name: Authentication
    description: OAuth 2.0 client-credentials token issuance
  - name: Lead intake
    description: Public lead creation
  - name: Reference data
    description: Read-only lookups — locations, developers, projects, project statuses
  - name: Lead follow-up
    description: >-
      Reading back who a lead was assigned to, and recording the agent response
      time
  - name: Webhooks
    description: >-
      Calls Provident makes to YOUR server. Documented here for the payload
      shape; these are not endpoints you call.
paths:
  /public/projects/filters:
    get:
      tags:
        - Reference data
      summary: Locations, developers, property types and statuses
      description: >-
        Returns every lookup list in one call. There is no standalone locations
        endpoint — this is where locations come from.


        Use `filters.location.values[].name` as the lead's `areaOfInterest` and
        `filters.propertyType.values[].name` as `propertyTypeInterest` so those
        values resolve instead of landing in `intakeUnresolved`. The UUIDs are
        the ones accepted by the project list filters.


        These lists change rarely — cache them (a daily refresh is plenty)
        rather than calling per lead, since reference reads share the lead
        endpoint's rate limit.
      operationId: getProjectFilters
      responses:
        '200':
          description: Filter lists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectFiltersResponse'
              example:
                filters:
                  developer:
                    displayName: Developer
                    values:
                      - id: 11111111-1111-1111-1111-111111111111
                        name: Emaar
                  location:
                    displayName: Location
                    values:
                      - id: 22222222-2222-2222-2222-222222222222
                        name: Dubai Marina
                        fullName: Dubai
                  propertyType:
                    displayName: Property Type
                    values:
                      - id: 33333333-3333-3333-3333-333333333333
                        name: Apartment
                  status:
                    displayName: Status
                    values:
                      - id: 44444444-4444-4444-4444-444444444444
                        name: Off-plan
                        color: '#00aaaa'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - bearerAuth: []
components:
  schemas:
    ProjectFiltersResponse:
      type: object
      properties:
        filters:
          type: object
          properties:
            developer:
              $ref: '#/components/schemas/FilterGroup'
            location:
              type: object
              properties:
                displayName:
                  type: string
                values:
                  type: array
                  items:
                    $ref: '#/components/schemas/LocationFilterValue'
            propertyType:
              allOf:
                - $ref: '#/components/schemas/FilterGroup'
              description: Send a value's `name` as the lead's `propertyTypeInterest`.
            status:
              type: object
              properties:
                displayName:
                  type: string
                values:
                  type: array
                  items:
                    $ref: '#/components/schemas/ProjectStatus'
            campaignType:
              $ref: '#/components/schemas/FilterGroup'
            ownershipType:
              $ref: '#/components/schemas/FilterGroup'
            stockAvailability:
              $ref: '#/components/schemas/FilterGroup'
          additionalProperties: true
    FilterGroup:
      type: object
      properties:
        displayName:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/FilterValue'
    LocationFilterValue:
      type: object
      description: >-
        A location. Send `name` as the lead's `areaOfInterest`; `id` is what the
        project filters accept.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
          example: Dubai Marina
        fullName:
          type: string
          nullable: true
          description: Parent location — use it to tell similarly named areas apart.
          example: Dubai
    ProjectStatus:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
          example: Off-plan
        color:
          type: string
          nullable: true
          example: '#00aaaa'
      additionalProperties: true
    ApiError:
      type: object
      description: Common error envelope used by every endpoint.
      properties:
        statusCode:
          type: integer
          example: 400
        code:
          type: string
          description: >-
            Stable machine-readable error code — branch on this, not on
            `message`.
          example: BAD_REQUEST
        message:
          type: string
          description: Human-readable description.
        errors:
          type: array
          items:
            type: string
          description: 'Present on 422 only: one entry per field that failed validation.'
        details:
          type: object
          additionalProperties: true
          description: Optional structured extras attached by the failing handler.
        path:
          type: string
          example: /v2/public/leads
        timestamp:
          type: string
          format: date-time
    FilterValue:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid, revoked or expired bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            statusCode: 401
            code: OAUTH_TOKEN_EXPIRED
            message: OAuth access token expired
            path: /v2/public/projects/filters
            timestamp: '2026-07-27T06:31:04.512Z'
    RateLimited:
      description: >-
        Request quota for this client exceeded. Wait `Retry-After` seconds, then
        resume.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          $ref: '#/components/headers/XRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/XRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/XRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            statusCode: 429
            code: RATE_LIMITED
            message: Too Many Requests
            path: /v2/public/leads
            timestamp: '2026-07-27T06:31:04.512Z'
  headers:
    XRateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    XRateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    XRateLimitReset:
      description: Seconds until the counter resets (end of the UTC day).
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        The `access_token` returned by `POST /oauth2/token`, sent as
        `Authorization: Bearer <access_token>`. It is an opaque string, not a
        JWT.

````