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

# Get Ghost integration

> Returns Ghost integration settings for a project, including whether the integration is enabled and the configured API URL.

Returns the Ghost integration settings for a project, including whether the integration is enabled and the configured API URL.

See the [Ghost integration guide](/docs-and-guides/integrations/publishing-platforms/ghost) for dashboard setup.


## OpenAPI

````yaml get /projects/{project_id}/integrations/ghost
openapi: 3.0.1
info:
  title: BeyondWords REST API
  description: |-
    This is the documentation for the BeyondWords REST API.
              You can use this API to use BeyondWords programmatically.
              You can get your API Key and Project ID for each project in the Project settings tab in the BeyondWords
              <a href="https://dash.beyondwords.io/dashboard">dashboard</a>.
  version: 1.0.0
servers:
  - url: https://api.beyondwords.io/v1
security: []
paths:
  /projects/{project_id}/integrations/ghost:
    parameters:
      - name: project_id
        in: path
        description: The numeric ID of your project
        required: true
        schema:
          type: string
    get:
      tags:
        - Ghost
      summary: Get Ghost integration
      description: >-
        Returns Ghost integration settings for a project, including whether the
        integration is enabled and the configured API URL.
      operationId: ghost#index
      parameters:
        - name: pagination[limit]
          in: query
          required: false
          description: '''limit'' sets the number of results to return in each page.'
          schema:
            type: integer
        - name: pagination[offset]
          in: query
          required: false
          description: >-
            'offset' sets the first position to return from the results of the
            query. The default is 0, which starts the page at the first result.
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/ghostIntegrationExample'
              schema:
                $ref: '#/components/schemas/ghostIntegrationModel'
        '401':
          description: Invalid authentication token
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/unauthorizedErrorExample'
              schema:
                $ref: '#/components/schemas/errorModel'
      security:
        - apiKey: []
components:
  examples:
    ghostIntegrationExample:
      summary: A sample Ghost integration
      value:
        enabled: false
        admin_api_key: 4a7ff4d73a1e36b9549449489c7cf85b
        api_url: https://localhost.ghost.io
        created: 2019-12-09 22:18:26 UTC
        updated: 2020-01-23 08:55:38 UTC
    unauthorizedErrorExample:
      summary: Unauthorized error
      value:
        code: 401
        message: Unauthorized
  schemas:
    ghostIntegrationModel:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether or not ghost should be enabled. The default is `disabled`.
        admin_api_key:
          type: string
          nullable: true
          description: Admin API key for Ghost integration
        api_url:
          type: string
          nullable: true
          description: Ghost API url
        created:
          type: string
          format: date-time
          description: Time at which the object was created (ISO 8601)
        updated:
          type: string
          format: date-time
          description: Time at which the object was updated (ISO 8601)
    errorModel:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        message:
          type: string
          description: Error message
        errors:
          type: array
          nullable: true
          items:
            type: object
            properties:
              location:
                type: string
              message:
                type: string
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````