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

# List sync status

> Returns per-endpoint sync status for the authenticated company, one row
per sync config, in ascending (partner name, endpoint key) order.
Reports data freshness (`last_updated_at`, reconciled across kroo-native
and Fivetran webhooks), scheduling, last-run health, and 24h partner
API-call volume. Paginated. Cached 60s.

**Required scope:** `read:sync_status`




## OpenAPI

````yaml GET /sync_status
openapi: 3.0.1
info:
  title: Kroo API v3
  version: 1.0.0
  description: |
    OAuth 2.0 Client Credentials authenticated API for machine-to-machine
    integrations.

    ## Authentication

    All v3 endpoints require Bearer token authentication. Request a token
    from `/oauth/token` with your client credentials, then send it on
    subsequent requests as `Authorization: Bearer <token>`. Tokens
    expire after 1 hour.

    ## Rate Limiting

    - V3 API endpoints: 60 requests per minute per IP
    - OAuth token endpoint: 10 requests per minute per IP

    Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`,
    and `X-RateLimit-Reset` headers. When the limit is exceeded the
    server returns `429 rate_limit_exceeded`; back off until the
    `X-RateLimit-Reset` Unix timestamp and retry.
  contact:
    name: Kroo API Support
    email: implementations@getkroo.com
servers:
  - url: https://api.getkroo.com/api/v3
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Authentication
    description: >-
      Exchange client credentials for short-lived Bearer tokens used to
      authorize every other v3 request.
  - name: Schedule Files
    description: >-
      Upload, list, retrieve, and delete P6 schedule files (XER, XML, PPX).
      Uploads are parsed and ingested asynchronously.
paths:
  /sync_status:
    get:
      tags:
        - Sync Status
      summary: List endpoint sync status
      description: |
        Returns per-endpoint sync status for the authenticated company, one row
        per sync config, in ascending (partner name, endpoint key) order.
        Reports data freshness (`last_updated_at`, reconciled across kroo-native
        and Fivetran webhooks), scheduling, last-run health, and 24h partner
        API-call volume. Paginated. Cached 60s.

        **Required scope:** `read:sync_status`
      operationId: listSyncStatus
      parameters:
        - name: partner
          in: query
          required: false
          description: Optional integration name to filter to a single partner.
          schema:
            type: string
            maxLength: 100
            example: procore
        - name: page
          in: query
          required: false
          description: 1-indexed page number. Clamped to [1, 10000].
          schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 1
        - name: per_page
          in: query
          required: false
          description: Page size. Clamped to [1, 100].
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
      responses:
        '200':
          description: Paginated sync status per endpoint
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SyncStatus'
                  meta:
                    type: object
                    required:
                      - page
                      - per_page
                      - total_count
                      - total_pages
                    properties:
                      page:
                        type: integer
                        description: Current page (1-indexed).
                      per_page:
                        type: integer
                        description: Page size applied to this response.
                      total_count:
                        type: integer
                        description: >-
                          Total number of sync configs for the authenticated
                          company (respecting the partner filter).
                      total_pages:
                        type: integer
                        description: Total number of pages at the current per_page.
        '400':
          description: Invalid request (e.g. partner parameter too long)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Token lacks required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    SyncStatus:
      type: object
      required:
        - id
        - type
        - attributes
      properties:
        id:
          type: string
          description: SyncConfig identifier.
        type:
          type: string
          enum:
            - sync_status
        attributes:
          type: object
          properties:
            endpoint_key:
              type: string
              description: Sync config key.
              example: procore_projects
            partner_name:
              type: string
              description: Integration name.
              example: procore
            status:
              type: string
              enum:
                - active
                - inactive
                - webhook
            last_updated_at:
              type: string
              format: date-time
              nullable: true
              description: |
                Data freshness — last completed sync landing time, reconciled
                across kroo-native and Fivetran webhooks. Null when no run has
                landed since the config's last recorded sync.
            next_sync_at:
              type: string
              format: date-time
              nullable: true
              description: Next scheduled sync time.
            last_sync_status:
              type: string
              nullable: true
              enum:
                - completed
                - failed
                - in_progress
                - timed_out
                - rate_limited
            last_sync_started_at:
              type: string
              format: date-time
              nullable: true
            last_sync_finished_at:
              type: string
              format: date-time
              nullable: true
            last_sync_duration_seconds:
              type: integer
              nullable: true
            frequency_minutes:
              type: integer
              nullable: true
              description: Expected sync cadence in minutes.
            api_calls_last_24h:
              type: integer
              description: |
                Utilization — count of API calls made to the partner in the last
                24h. Distinct from last_updated_at (data freshness).
    Error:
      type: object
      required:
        - error
        - error_description
      properties:
        error:
          type: string
          description: >-
            Machine-readable error code. See the operation description for the
            codes a specific endpoint can return.
        error_description:
          type: string
          description: >-
            Human-readable description of the error. Safe to log; do not show to
            end users verbatim.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token obtained from `POST /oauth/token`. Send as `Authorization:
        Bearer <token>`. Tokens expire after 1 hour; refresh by requesting a new
        one with the same client credentials.

````