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

# Resolve effective employee field sources

> Returns the source that owns each requested employee field. An employee override takes precedence over the company default; fields with neither are omitted. Accepts up to 1000 employee IDs and 100 field keys. Repeated inputs are processed once in first-seen order. Every employee ID must belong to the company or the whole request returns 404. Omit fieldKeys to resolve all supported fields; an empty array for either input returns no results. isSyncing is true when Windmill can refresh the connected source and the latest saved field value has not been confirmed by that source. It does not indicate whether a sync job is running. This read does not start a sync or return employee field values. Requires permission to manage employee field sources (`employees.manage_field_mappings`).



## OpenAPI

````yaml https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/field-sources/resolve
openapi: 3.1.0
info:
  title: Windmill API
  version: 2.0.0
  description: >-
    Use the Windmill API to integrate your systems, automate workflows, and
    build applications on your organization's data. Authenticate with an API key
    or OAuth access token. Each request uses the authenticated user's
    permissions within the selected workspace.
servers:
  - url: https://api.gowindmill.com/api/v2
security:
  - bearerAuth: []
paths:
  /c/{companyId}/field-sources/resolve:
    post:
      tags:
        - Employee Field Sources
      summary: Resolve effective employee field sources
      description: >-
        Returns the source that owns each requested employee field. An employee
        override takes precedence over the company default; fields with neither
        are omitted. Accepts up to 1000 employee IDs and 100 field keys.
        Repeated inputs are processed once in first-seen order. Every employee
        ID must belong to the company or the whole request returns 404. Omit
        fieldKeys to resolve all supported fields; an empty array for either
        input returns no results. isSyncing is true when Windmill can refresh
        the connected source and the latest saved field value has not been
        confirmed by that source. It does not indicate whether a sync job is
        running. This read does not start a sync or return employee field
        values. Requires permission to manage employee field sources
        (`employees.manage_field_mappings`).
      operationId: fieldSources.resolve
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            description: >-
              Company ID. A URL slug is also accepted. The caller must have
              access to this company.
            title: Company ID
            example: company-acme
          required: true
          description: >-
            Company ID. A URL slug is also accepted. The caller must have access
            to this company.
          name: companyId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolveEmployeeFieldSourcesRequest'
      responses:
        '200':
          description: >-
            Effective employee field owners and source-confirmation status;
            unowned pairs omitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResolveEmployeeFieldSourceIdsResponse'
        '400':
          description: Bad request or request validation failed
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - BAD_REQUEST
                          message:
                            type: string
                          requestId:
                            type: string
                        required:
                          - code
                          - message
                          - requestId
                    required:
                      - error
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - VALIDATION_ERROR
                          message:
                            type: string
                          requestId:
                            type: string
                          details:
                            type: array
                            items:
                              type: object
                              properties:
                                path:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: string
                                      - type: number
                                message:
                                  type: string
                              required:
                                - path
                                - message
                        required:
                          - code
                          - message
                          - requestId
                          - details
                    required:
                      - error
        '401':
          description: >-
            Authentication is missing or invalid. Send a valid API key or OAuth
            access token in the Authorization: Bearer <TOKEN> header before
            retrying.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - UNAUTHORIZED
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - FORBIDDEN
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - NOT_FOUND
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '429':
          description: >-
            The API-client request budget is exhausted. API keys allow 500
            requests per minute per key; OAuth clients allow 500 per minute per
            client and workspace. Reads and writes share the budget. One HTTP
            request counts once, including bulk requests. Wait for the
            Retry-After delay before retrying.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                type: integer
                minimum: 0
                example: 42
            RateLimit:
              description: >-
                Current request budget: limit is the maximum count, remaining is
                the unused count, and reset is seconds until the window resets,
                not a timestamp.
              required: true
              schema:
                type: string
                example: limit=500, remaining=0, reset=42
            RateLimit-Policy:
              description: >-
                Request limit and window length in seconds, formatted as
                <limit>;w=<seconds>.
              required: true
              schema:
                type: string
                example: 500;w=60
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - RATE_LIMITED
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
      security:
        - bearerAuth: []
components:
  schemas:
    ResolveEmployeeFieldSourcesRequest:
      type: object
      properties:
        employeeIds:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 256
          maxItems: 1000
          description: >-
            Up to 1000 employee IDs, each 1–256 characters. Every ID must belong
            to the company. Repeated IDs are resolved once in first-seen order.
            An empty array returns no resolutions.
          title: Employee IDs
          example:
            - employee-avery
        fieldKeys:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeFieldKey'
          maxItems: 100
          description: >-
            Up to 100 field keys. Repeated keys are resolved once in first-seen
            order. Omit to inspect all supported field keys; an empty array
            resolves no fields.
          title: Field keys
          example:
            - jobTitle
      required:
        - employeeIds
      title: Resolve field owners request
      example:
        employeeIds:
          - employee-avery
        fieldKeys:
          - jobTitle
    ResolveEmployeeFieldSourceIdsResponse:
      type: object
      properties:
        resolutions:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeFieldSourceResolution'
      required:
        - resolutions
    EmployeeFieldKey:
      type: string
      enum:
        - avatarUrl
        - dateOfBirth
        - departments
        - displayFullName
        - employmentStatus
        - employmentType
        - ethnicity
        - firstName
        - preferredName
        - gender
        - jobLevel
        - jobTitle
        - lastName
        - managerId
        - maritalStatus
        - phoneNumber
        - primaryEmail
        - pronouns
        - startDate
        - terminationDate
        - workLocation
        - country
      description: Employee profile field whose owning source is configured or resolved.
      title: Employee field key
      example: jobTitle
    EmployeeFieldSourceResolution:
      type: object
      properties:
        employeeId:
          type: string
          description: Requested employee ID for this field resolution.
          title: Employee ID
          example: employee-avery
        fieldKey:
          $ref: '#/components/schemas/EmployeeFieldKey'
        source:
          $ref: '#/components/schemas/EmployeeFieldSourceId'
        isSyncing:
          type: boolean
          description: >-
            True when Windmill can refresh the connected source and the latest
            saved field value has not been confirmed by that source. This does
            not mean a sync is running. False does not guarantee that the value
            is up to date.
          title: Awaiting source confirmation
          example: false
      required:
        - employeeId
        - fieldKey
        - source
        - isSyncing
    EmployeeFieldSourceId:
      type: string
      enum:
        - manual
        - system
        - scim
        - slack
        - slack-analytics
        - google-workspace
        - google-workspace-individual
        - notion
        - airtable
        - attio
        - gong
        - monday
        - merge
        - adp-workforce-now
        - bamboo-hr
        - charthop
        - darwinbox
        - dayforce
        - deel
        - gusto
        - hibob
        - humaans
        - just-works
        - oracle-hcm
        - outlook-calendar
        - paylocity
        - rippling
        - trinet
        - ukg-pro
        - workday
        - asana
        - bonusly
        - claude
        - clickup
        - codex
        - cursor
        - devin
        - figma
        - front
        - github
        - granola
        - hubspot
        - intercom
        - jira
        - linear
        - pipedrive
        - roam
        - salesforce
        - slack-agent
        - windmill
        - zendesk
        - zendesk-chat
        - zoom
      description: >-
        Public source identifier. Saved configurations may retain a disconnected
        source.
      example: bamboo-hr
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an API key or OAuth access token. Enter only the token in the
        authorization dialog; requests send it as `Authorization: Bearer
        <TOKEN>`.


        Create an API key in your workspace's **Settings → API keys**. Keys
        start with `wm_api_` and only work in the workspace where they were
        created. Read-only keys can read data; creating, updating, or deleting
        data requires a read-write key.


        ```http

        Authorization: Bearer wm_api_example

        ```


        OAuth access tokens are issued for connected Windmill applications.


        ```http

        Authorization: Bearer <OAUTH_ACCESS_TOKEN>

        ```


        Both token types use the authenticated user's workspace permissions.
        Each endpoint's permission requirements and the sharing settings of the
        requested items still apply.

````

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