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

# List the workspace's LinkedIn company pages

> Every company page discovered or activated in the active
workspace — the delta over `GET /projects`: activation status,
STORED admin token health (as of last validation), follower
count, and the activated project's engagement-policy state.
Requires the `projects:read` scope.




## OpenAPI

````yaml /openapi/v1.yaml get /company-pages
openapi: 3.1.0
info:
  title: Scripe Public API
  version: '2026-08-10'
  summary: >-
    Read and write Scripe workspace data — posts, notes, ideas, sources,
    knowledge, media, analytics, usage, async jobs, and webhooks.
  description: |
    The Scripe public API gives integrators stable, versioned access to a
    workspace's content surface: reads across every resource, synchronous
    writes (notes, posts, ideas, text sources, media assets), async jobs
    (post generation, file/URL/YouTube ingest, image and carousel
    generation), usage meters, and outbound webhooks.

    All endpoints (except `/v1/health`) require a Bearer token — either a
    workspace API key (`scripe_sk_*`) or an OAuth 2.1 access token
    (`scripe_oat_*`). Pin the API version with the `Scripe-Api-Version`
    request header to opt out of breaking changes.
  contact:
    name: Scripe Support
    url: https://scripe.io/support
    email: support@scripe.io
  license:
    name: Proprietary
servers:
  - url: https://api.scripe.io/v1
    description: Production
security:
  - BearerApiKey: []
tags:
  - name: Health
    description: Liveness and authenticated key smoke tests.
  - name: Workspace
    description: The workspace + principal resolved from your API key.
  - name: Projects
    description: Personal-brand, company-page, and amplifier projects.
  - name: Notes
    description: Project notes with paired calendar slot.
  - name: Posts
    description: Drafts, scheduled, and published LinkedIn posts.
  - name: Analytics
    description: Your own LinkedIn analytics and viral-post inspiration search.
  - name: Sources
    description: Transcriptions (audio/video sources) with truncated body.
  - name: Uploads
    description: >-
      Pre-signed S3 PUT URLs the customer uploads bytes to before referencing
      via Sources or Knowledge.
  - name: Knowledge
    description: >-
      Knowledge-base documents indexed for RAG. Async ingest via text, file,
      URL, or YouTube.
  - name: Jobs
    description: >-
      Async-job lifecycle — submitted via post-generation, knowledge ingest,
      file source.
  - name: Calendar
    description: >-
      The content calendar — scheduled/planned posts, note slots, idea
      placements, and the posting-time template.
  - name: Ideas
    description: >-
      The idea board — creative briefs with derived workflow statuses and
      date-level calendar placement.
  - name: Media
    description: >-
      Media-library search, own-image imports, AI image generation, and
      full-state media writes onto posts.
  - name: Settings
    description: >-
      Curated project settings, engagement policy, and company pages (read-only
      over REST).
  - name: Webhooks
    description: |
      Outbound HTTP callbacks. Subscribe an endpoint to one or more
      event names; we POST a signed JSON payload every time a matching
      event fires in the workspace. The signing secret is shown once
      on create and once on rotate — verify the
      `Webhook-Signature: t=<ts>,v1=<hmac>` header on every delivery.
paths:
  /company-pages:
    get:
      tags:
        - Settings
        - Projects
      summary: List the workspace's LinkedIn company pages
      description: |
        Every company page discovered or activated in the active
        workspace — the delta over `GET /projects`: activation status,
        STORED admin token health (as of last validation), follower
        count, and the activated project's engagement-policy state.
        Requires the `projects:read` scope.
      operationId: listCompanyPages
      parameters:
        - $ref: '#/components/parameters/ScripeApiVersion'
      responses:
        '200':
          description: The workspace's company pages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyPageListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    ScripeApiVersion:
      name: Scripe-Api-Version
      in: header
      required: false
      description: |
        Pin the API version. Format `YYYY-MM-DD`. Omit to receive the
        currently rolling default. Unknown versions return `400
        version_unsupported`.
      schema:
        type: string
        example: '2026-08-10'
  schemas:
    CompanyPageListResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            type: object
            required:
              - id
              - name
              - status
              - activatedProject
              - adminTokenHealth
              - engagementPolicy
              - createdAt
            properties:
              id:
                type: string
                example: cpg_a1b2c3d4e5f6g7h8
              name:
                type: string
                nullable: true
              vanityName:
                type: string
                nullable: true
              logoUrl:
                type: string
                nullable: true
              status:
                type: string
                enum:
                  - discovered
                  - activated
              activatedProject:
                type: object
                nullable: true
                properties:
                  id:
                    type: string
                  name:
                    type: string
              activatedAt:
                type: string
                nullable: true
              followerCount:
                type: integer
                nullable: true
              adminTokenHealth:
                type: array
                description: >-
                  Stored token health per admin project, healthiest first — as
                  of last validation, never a live probe.
                items:
                  type: object
                  required:
                    - projectId
                    - tokenStatus
                    - lastVerifiedAt
                    - failureReason
                  properties:
                    projectId:
                      type: string
                    tokenStatus:
                      type: string
                      enum:
                        - valid
                        - unknown
                        - failing
                        - revoked
                    lastVerifiedAt:
                      type: string
                      nullable: true
                    failureReason:
                      type: string
                      nullable: true
              engagementPolicy:
                type: object
                nullable: true
                properties:
                  likeDefault:
                    $ref: '#/components/schemas/EngagementPolicyState'
                  commentDefault:
                    $ref: '#/components/schemas/EngagementPolicyState'
                  reshareDefault:
                    $ref: '#/components/schemas/EngagementPolicyState'
              createdAt:
                type: string
    EngagementPolicyState:
      type: string
      enum:
        - 'OFF'
        - REQUEST
        - 'ON'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
            - docs_url
          properties:
            code:
              type: string
              description: Stable, machine-readable error identifier.
              example: not_found
            message:
              type: string
            request_id:
              type: string
              example: req_a1b2c3d4e5f6
            docs_url:
              type: string
              format: uri
            details:
              description: Optional structured payload — shape varies per code.
  responses:
    Unauthorized:
      description: Missing, malformed, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Plan not eligible, scope missing, or workspace mismatch.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Sliding-window rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: integer
        X-RateLimit-Limit:
          schema:
            type: integer
        X-RateLimit-Remaining:
          schema:
            type: integer
        X-RateLimit-Reset:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: scripe_sk_live_*
      description: |
        Pass `Authorization: Bearer scripe_sk_live_<...>` (or
        `scripe_sk_test_<...>` for test keys) on every request. Keys
        are scoped to a single workspace and can be revoked from the
        Scripe dashboard.

        The same header also accepts an OAuth 2.1 access token
        (`scripe_oat_*`); both credentials share one scope vocabulary
        and every operation below documents the scope it requires.
        An API key can hold every scope named on this surface except
        `webhooks:manage`, which is grantable to OAuth tokens only
        today — the webhook-endpoint operations answer
        `403 scope_missing` to every API key. Operations that name no
        scope accept any valid token of the workspace.

````