> ## 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.

# Share a custom report

> Generates a shareable URL for a custom report. When the report is `secure=true`, parameters are JWT-encoded so locked values cannot be tampered with. The share URL can be opened by anyone without a ConveYour login.

Generate a shareable URL for a custom report



## OpenAPI

````yaml /api-reference/specs/reports.json post /api/custom-reports/{id}/share
openapi: 3.1.0
info:
  title: ConveYour API — Reports
  description: >-
    Retrieve report data, run report actions, access shared reports, and manage
    custom report templates.
  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: Reports
    description: >-
      Retrieve report data, run report actions, access shared reports, and
      manage custom report templates.
paths:
  /api/custom-reports/{id}/share:
    post:
      tags:
        - Reports
      summary: Share a custom report
      description: >-
        Generates a shareable URL for a custom report. When the report is
        `secure=true`, parameters are JWT-encoded so locked values cannot be
        tampered with. The share URL can be opened by anyone without a ConveYour
        login.


        Generate a shareable URL for a custom report
      operationId: generateAShareableUrlForACustomReport
      parameters:
        - name: id
          in: path
          required: true
          description: The id identifier.
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                params:
                  description: >-
                    The parameter values to encode in the JWT token. Used for
                    locked parameters that differ per share link (e.g. scoping a
                    report to a specific office ID).
                  type: object
                  additionalProperties: true
                expires:
                  description: >-
                    Token expiration window. Default: `+8 hours`. Options: `+1
                    hour`, `+8 hours`, `+24 hours`, `+7 days`, `+30 days`, `+90
                    days`, `+1 year`.
                  type: string
                config:
                  type: object
                  description: >-
                    Extra configuration to encode into the share token.
                    Supplying this forces a custom token to be generated, and
                    only takes effect on a secure report.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ShareUrl'
              example:
                status: ok
                message: Share URL generated
                data:
                  url: >-
                    https://<your-subdomain>.conveyour.com/ui/reports/shared/abc123def456?token=eyJhbGciOiJIUzI1...
                  expires: +30 days
                  params:
                    office_id: office_101
                    office_name: Downtown Office
        '403':
          $ref: '#/components/responses/ForbiddenToken'
        '404':
          $ref: '#/components/responses/NotFound'
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.
    ShareUrl:
      type: object
      properties:
        url:
          type: string
          description: >-
            The shareable report URL, with a signed token when the report is
            secure.
        expires:
          type: string
          description: Expiration string that was applied. Defaults to '+8 hours'.
        params:
          type: object
          description: The params that were encoded into the token.
      required:
        - url
        - expires
        - params
  responses:
    ForbiddenToken:
      description: >-
        The token is missing, expired, or not permitted for this HTTP method.
        **This endpoint enforces no named permission**, so a 403 here never
        carries a `permission` field.
      content:
        application/json:
          example:
            status: failed
            message: Token is either expired or does not have the correct permissions
            data: []
    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.