ClickFunnels Blogs::Author API

openapi: 3.2.0
info:
  title: ClickFunnels Blogs::Author API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Blogs::Author
  description: Blog Authors. See [Authors (read-only)](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md#authors-read-only) in the [Blogs Skill](https://accounts.myclickfunnels.com/.well-known/blogs/skill.md).
paths:
  /blogs/{blog_id}/authors:
    get:
      tags:
      - Blogs::Author
      summary: List Blog Authors
      description: List the authors within the given blog.
      operationId: listBlogsAuthors
      parameters:
      - name: blog_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BlogsAuthorAttributes'
              example:
              - id: 1
                public_id: aAbCdE
                blog_id: 1
                first_name: Jane
                last_name: Smith
                email_address: jane@example.com
                image_id: 42
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                full_name: Jane Smith
                display_name: Jane Smith
                image_url: https://example.myclickfunnels.com/uploads/image/42/file/example.jpg
              - id: 2
                public_id: aFgHiJ
                blog_id: 1
                first_name: John
                last_name: Doe
                email_address: john@example.com
                image_id: null
                created_at: '2025-01-15T00:00:00.000Z'
                updated_at: '2025-01-15T00:00:00.000Z'
                full_name: John Doe
                display_name: John Doe
                image_url: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
  /blogs/authors/{id}:
    get:
      tags:
      - Blogs::Author
      summary: Fetch Blog Author
      description: Retrieve a blog author.
      operationId: getBlogAuthor
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlogsAuthorAttributes'
              example:
                id: 1
                public_id: aAbCdE
                blog_id: 1
                first_name: Jane
                last_name: Smith
                email_address: jane@example.com
                image_id: 42
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                full_name: Jane Smith
                display_name: Jane Smith
                image_url: https://example.myclickfunnels.com/uploads/image/42/file/example.jpg
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: 'Sort property of a list response. The default is id and thus the created_at order.

        If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  schemas:
    BlogsAuthorAttributes:
      type: object
      title: Blogs::Author
      description: Blog Authors
      required:
      - blog_id
      - created_at
      - display_name
      - email_address
      - first_name
      - full_name
      - id
      - image_id
      - image_url
      - last_name
      - public_id
      - updated_at
      properties:
        id:
          type: integer
          description: Author ID
        public_id:
          type: string
          description: The public identifier of the author
        blog_id:
          type: integer
          description: Blog ID that the author belongs to
        first_name:
          type:
          - string
          - 'null'
          description: Author first name
        last_name:
          type:
          - string
          - 'null'
          description: Author last name
        email_address:
          type:
          - string
          - 'null'
          description: Author email address
        image_id:
          type:
          - integer
          - 'null'
          description: ID of the author's profile image
        created_at:
          type: string
          format: date-time
          description: Created at
        updated_at:
          type: string
          format: date-time
          description: Updated at
        full_name:
          type:
          - string
          - 'null'
          description: The author's full name
        display_name:
          type:
          - string
          - 'null'
          description: The author's display name
        image_url:
          type:
          - string
          - 'null'
          description: The URL of the author's profile image
      example:
        id: 1
        public_id: aAbCdE
        blog_id: 1
        first_name: Jane
        last_name: Smith
        email_address: jane@example.com
        image_id: 42
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
        full_name: Jane Smith
        display_name: Jane Smith
        image_url: https://example.myclickfunnels.com/uploads/image/42/file/example.jpg
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com