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

# Get export status by public ID

> Public export status lookup by `pid`. No authentication required. Returns only non-sensitive fields, intended for a status-polling page.

None | Look up export status by public pid

This endpoint requires **no authentication**. Anyone who has the export `pid` can read its status — treat the pid as a secret and do not put it in logs, referrer-visible URLs, or client-side code you do not control.



## OpenAPI

````yaml /api-reference/specs/exports.json get /api/exports/public/{pid}
openapi: 3.1.0
info:
  title: ConveYour API — Exports
  description: Download generated data exports and check export status.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Exports
    description: Download generated data exports and check export status.
paths:
  /api/exports/public/{pid}:
    get:
      tags:
        - Exports
      summary: Get export status by public ID
      description: >-
        Public export status lookup by `pid`. No authentication required.
        Returns only non-sensitive fields, intended for a status-polling page.


        None | Look up export status by public pid


        This endpoint requires **no authentication**. Anyone who has the export
        `pid` can read its status — treat the pid as a secret and do not put it
        in logs, referrer-visible URLs, or client-side code you do not control.
      operationId: noneLookUpExportStatusByPublicPid
      parameters:
        - name: pid
          in: path
          description: The export's public `pid` (a 32-character random string).
          schema:
            type: string
          required: true
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ExportStatus'
              example:
                status: ok
                message: Export status
                data:
                  name: Contacts Export
                  status: ready
                  progress: 1
                  created_at: 1717027200
                  expires_at: 1717632000
                  is_expired: false
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security: []
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    ExportStatus:
      type: object
      description: >-
        Public export status. Only these six keys are returned; the full Export
        record is not.
      properties:
        name:
          type: string
          description: Export name.
        status:
          type: string
          description: Job status.
        progress:
          type: number
          description: Always a float.
        created_at:
          type: integer
          description: Unix timestamp.
        expires_at:
          type: integer
          description: Unix timestamp after which the bundle expires.
        is_expired:
          type: boolean
      required:
        - name
        - status
        - progress
        - created_at
        - expires_at
        - is_expired
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
    NotFound:
      description: No record matched the supplied ID.
      content:
        application/json:
          example:
            status: failed
            message: Contact not found
            data: []
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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