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

# Refresh Profiles



## OpenAPI

````yaml /partner-api/openapi.json post /api/Refresh/RefreshProfiles
openapi: 3.0.1
info:
  title: SeekOut Partner API
  version: '1.0'
  description: >-
    The SeekOut Partner API provides direct, programmatic REST access to
    SeekOut's talent search engine. Use it to build custom integrations,
    dashboards, scheduled jobs, and backend workflows for candidate search,
    profile matching, contact retrieval, and analytics. Authenticate every
    request with your `Api-Key` header, provisioned by your SeekOut
    representative.
servers:
  - url: https://partnerapi.seekout.io
    description: SeekOut Partner API
security:
  - ApiKey: []
paths:
  /api/Refresh/RefreshProfiles:
    post:
      tags:
        - Refresh
      summary: Refresh Profiles
      operationId: refreshProfiles
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/PartnerApiWebService.Models.RefreshProfilesRequest
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PartnerApiWebService.Models.RefreshProfilesRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/PartnerApiWebService.Models.RefreshProfilesRequest
          application/*+json:
            schema:
              $ref: >-
                #/components/schemas/PartnerApiWebService.Models.RefreshProfilesRequest
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/PartnerApiWebService.Models.RefreshProfilesResponse
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PartnerApiWebService.Models.RefreshProfilesResponse
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/PartnerApiWebService.Models.RefreshProfilesResponse
components:
  schemas:
    PartnerApiWebService.Models.RefreshProfilesRequest:
      required:
        - apiKey
        - profileHandles
      type: object
      properties:
        profileHandles:
          type: array
          items:
            type: string
        apiKey:
          minLength: 1
          type: string
        batchSize:
          type: integer
          format: int32
          nullable: true
        maxConcurrency:
          type: integer
          format: int32
          nullable: true
        saveToStorage:
          type: boolean
        jobId:
          type: string
          nullable: true
      additionalProperties: false
    PartnerApiWebService.Models.RefreshProfilesResponse:
      type: object
      properties:
        jobId:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/PartnerApiWebService.Models.RefreshJobStatus'
        totalRequested:
          type: integer
          format: int32
        totalProcessed:
          type: integer
          format: int32
        totalSuccessful:
          type: integer
          format: int32
        totalFailed:
          type: integer
          format: int32
        successfulRefreshes:
          type: array
          items:
            type: string
          nullable: true
        failedRefreshes:
          type: array
          items:
            $ref: '#/components/schemas/PartnerApiWebService.Models.RefreshFailure'
          nullable: true
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
          nullable: true
        duration:
          type: string
          format: date-span
          nullable: true
          readOnly: true
        dataUrl:
          type: string
          nullable: true
        progressUrl:
          type: string
          nullable: true
        progressPercentage:
          type: number
          format: double
          readOnly: true
      additionalProperties: false
    PartnerApiWebService.Models.RefreshJobStatus:
      enum:
        - Queued
        - InProgress
        - Completed
        - Failed
        - Cancelled
      type: string
    PartnerApiWebService.Models.RefreshFailure:
      type: object
      properties:
        handle:
          type: string
          nullable: true
        error:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Api-Key
      description: >-
        Organization-scoped API key provisioned by SeekOut. Send it in the
        `Api-Key` header on every request.

````