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

# List the fields a synced action's data can be queried by

> Returns the field names and types accepted by `filter`, `sort`, `source` and `aggs` on `POST /actions/rpc/synced`, discovered from this account's synced records. Returns an empty `fields` list when the action is not sync-enabled for the account or has no readable sync yet.



## OpenAPI

````yaml post /actions/rpc/synced/queryable_fields
openapi: 3.1.0
info:
  title: StackOne
  description: The documentation for the StackOne API
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.stackone.com
security: []
tags:
  - name: Accounts
    description: View and manage linked accounts.
  - name: Actions
    description: Retrieve Actions metadata and definitions.
  - name: AI
    description: AI-powered features.
  - name: Auth Configs
    description: View and manage connector auth configurations for the project.
  - name: Connect Sessions
    description: >-
      Generate connection session tokens or auth URLs to allow your customers to
      connect their accounts.
  - name: Connector Profiles
    description: View and manage connector profiles for the project.
  - name: Connectors
    description: Retrieve metadata for connectors.
  - name: Logs
    description: API request logs and analytics.
  - name: MCP
    description: Model Context Protocol endpoint.
  - name: Proxy
    description: Routing API requests through StackOne directly to the underlying provider.
  - name: Request Logs
    description: API requests and response logs.
  - name: Webhooks
    description: Configure and manage webhooks.
paths:
  /actions/rpc/synced/queryable_fields:
    post:
      tags:
        - Actions
      summary: List the fields a synced action's data can be queried by
      description: >-
        Returns the field names and types accepted by `filter`, `sort`, `source`
        and `aggs` on `POST /actions/rpc/synced`, discovered from this account's
        synced records. Returns an empty `fields` list when the action is not
        sync-enabled for the account or has no readable sync yet.
      operationId: stackone_rpc_action_synced_queryable_fields
      parameters:
        - name: x-account-id
          in: header
          description: The account identifier
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionsRpcSyncedQueryableFieldsRequestDto'
      responses:
        '200':
          description: The queryable fields and the readable syncs of the action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionsSyncedQueryableFieldsResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '408':
          description: The request has timed out.
          headers:
            Retry-After:
              description: A time in seconds after which the request can be retried.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimedOutResponse'
        '409':
          description: Conflict with current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictResponse'
        '412':
          description: >-
            Precondition failed: the linked account is suspended, expired,
            archived, or in an error state. `errorCode` identifies which.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreconditionFailedResponse'
        '422':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsResponse'
        '500':
          description: Server error while executing the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
        '501':
          description: This functionality is not implemented.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplementedResponse'
        '502':
          description: Bad gateway error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayResponse'
      security:
        - basic: []
components:
  schemas:
    ActionsRpcSyncedQueryableFieldsRequestDto:
      type: object
      properties:
        action:
          type: string
          description: The synced action to list queryable fields for
          example: hris_list_employees
      required:
        - action
    ActionsSyncedQueryableFieldsResponse:
      type: object
      properties:
        action_id:
          type: string
          description: The action the fields belong to.
        fields:
          description: >-
            Fields discovered from this account's synced records. Empty when the
            action has no readable sync yet.
          type: array
          items:
            $ref: '#/components/schemas/ActionsSyncedQueryableField'
        syncs:
          description: Each readable sync of the action, with its freshness.
          type: array
          items:
            $ref: '#/components/schemas/ActionsSyncedQueryableFieldsSync'
        synced_at:
          type: string
          description: >-
            Present only when there is exactly one readable sync: when it was
            synced.
          nullable: true
        expires_at:
          type: string
          description: >-
            Present only when there is exactly one readable sync: when it
            expires.
          nullable: true
      required:
        - action_id
        - fields
        - syncs
    BadRequestResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 400
        message:
          type: string
          description: Error message
          example: Bad Request
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
        data:
          description: Error details
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/UnifiedError'
        provider_errors:
          description: List of provider-specific errors
          nullable: true
          type: array
          items:
            $ref: '#/components/schemas/ProviderError'
      required:
        - statusCode
        - message
        - timestamp
    UnauthorizedResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 401
        message:
          type: string
          description: Error message
          example: Unauthorized
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    ForbiddenResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 403
        message:
          type: string
          description: Error message
          example: Forbidden resource
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    NotFoundResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 404
        message:
          type: string
          description: Error message
          example: Not Found
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    RequestTimedOutResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 408
        message:
          type: string
          description: Error message
          example: Request timed out
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    ConflictResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 409
        message:
          type: string
          description: Error message
          example: Conflict
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    PreconditionFailedResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 412
        message:
          type: string
          description: Error message
          example: Account is suspended and cannot process requests
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
        errorCode:
          type: string
          description: Identifies which account status blocked the request
          enum:
            - AccountSuspendedError
            - AccountExpiredError
            - AccountArchivedError
            - AccountErrorStatus
          example: AccountSuspendedError
          x-speakeasy-unknown-values: allow
        details:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/PreconditionFailedDetails'
      required:
        - statusCode
        - message
        - timestamp
        - errorCode
    UnprocessableEntityResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 422
        message:
          type: string
          description: Error message
          example: Unprocessable Entity
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    TooManyRequestsResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 429
        message:
          type: string
          description: Error message
          example: Too many requests
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    InternalServerErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 500
        message:
          type: string
          description: Error message
          example: Internal server error
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    NotImplementedResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 501
        message:
          type: string
          description: Error message
          example: Not Implemented
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    BadGatewayResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 502
        message:
          type: string
          description: Error message
          example: Bad Gateway
        timestamp:
          type: string
          description: Timestamp when the error occurred
          example: '2023-05-30T00:00:00.000Z'
          format: date-time
      required:
        - statusCode
        - message
        - timestamp
    ActionsSyncedQueryableField:
      type: object
      properties:
        field:
          type: string
          description: Field name to use in `filter`, `sort`, `source` and `aggs`.
        type:
          type: string
          description: The field type in the synced index, e.g. `keyword` or `date`.
      required:
        - field
        - type
    ActionsSyncedQueryableFieldsSync:
      type: object
      properties:
        sync_id:
          type: string
          description: Pass this as `sync_id` to read this sync.
        sync_name:
          type: string
          description: The sync's raw name. Not unique, and may be the bare action id.
        synced_at:
          type: string
          description: ISO 8601 timestamp of when the data was synced
        expires_at:
          type: string
          description: ISO 8601 timestamp of when the synced data expires
      required:
        - sync_id
        - sync_name
        - synced_at
        - expires_at
    UnifiedError:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 400
          nullable: true
        message:
          type: string
          description: Error message
          example: Bad Request
          nullable: true
        headers:
          type: object
          description: Response headers
          example:
            content-type: application/json
            x-request-id: 5678c28b211dace4e0a0f9171e6b88c5
          nullable: true
    ProviderError:
      type: object
      properties:
        status:
          type: number
          description: HTTP status code of the provider error
          example: 400
          nullable: true
        url:
          type: string
          description: URL that caused the error
          example: https://api.provider.com/v1/resource
          nullable: true
        raw:
          type: object
          description: Raw error response from the provider
          example:
            message: Invalid input parameters
          nullable: true
        headers:
          type: object
          description: Response headers
          example:
            content-type: application/json
            x-request-id: 5678c28b211dace4e0a0f9171e6b88c5
          nullable: true
    PreconditionFailedDetails:
      type: object
      properties:
        status:
          type: string
          description: The account status that blocked the request
          enum:
            - suspended
            - expired
            - archived
            - error
          example: suspended
          x-speakeasy-unknown-values: allow
        expiresAt:
          type: string
          description: When the test account expired. Present when status is expired
          format: date-time
          nullable: true
        statusReasons:
          description: Why the account is in an error state. Present when status is error
          nullable: true
          type: array
          items:
            $ref: '#/components/schemas/StatusReason'
      required:
        - status
    StatusReason:
      type: object
      properties:
        code:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        timestamp:
          type: string
          format: date-time
      required:
        - timestamp
  securitySchemes:
    basic:
      type: http
      scheme: basic

````

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