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

# Claim the next permitted action

> Hands out one action, if and only if the governor allows it: the account is active and unpaused, the kind still has daily headroom, the rolling weekly invitation ceiling is not reached, warm-up permits it, and credit covers it. When nothing is handed out the response says why, which is what lets the panel distinguish an empty queue from a paced one.



## OpenAPI

````yaml /openapi.json post /linkedin/agent/actions/next/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: Sender profiles, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for creating and managing integrations.
    name: integrations
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for teaching a saved agent from example rows: training sessions,
      per-row feedback, and the proposed prompt to approve.
    name: agent-training
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      The per-table AI Assistant: named conversations, the column suggestions a
      build turn produces, and the questions an analyze turn answers.
    name: table-assistant
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context — company description,
      ideal customer profile, buyer personas and interest signals — plus
      domain-based generation.
    name: ai-context
paths:
  /linkedin/agent/actions/next/:
    post:
      tags:
        - linkedin
      summary: Claim the next permitted action
      description: >-
        Hands out one action, if and only if the governor allows it: the account
        is active and unpaused, the kind still has daily headroom, the rolling
        weekly invitation ceiling is not reached, warm-up permits it, and credit
        covers it. When nothing is handed out the response says why, which is
        what lets the panel distinguish an empty queue from a paced one.
      operationId: linkedin_agent_pull_next
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentHeartbeatSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentNextActionSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: The agent token is invalid, revoked, or expired.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
components:
  schemas:
    AgentHeartbeatSchema:
      properties:
        checkpoint:
          anyOf:
            - type: boolean
            - type: 'null'
          description: True when LinkedIn is challenging the account; auto-pauses it.
          title: Checkpoint
        extension_version:
          default: ''
          maxLength: 32
          title: Extension Version
          type: string
        lease_nonce:
          description: This browser's lease identity; only the holder is handed work.
          maxLength: 64
          minLength: 8
          title: Lease Nonce
          type: string
        member_urn:
          anyOf:
            - maxLength: 128
              type: string
            - type: 'null'
          description: Who the browser is currently signed in as, for the mismatch guard.
          title: Member Urn
      required:
        - lease_nonce
      title: AgentHeartbeatSchema
      type: object
    AgentNextActionSchema:
      properties:
        action:
          anyOf:
            - $ref: '#/components/schemas/LinkedInActionReadSchema'
            - type: 'null'
        checkpoint:
          title: Checkpoint
          type: boolean
        deferred_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Deferred Reason
        earliest_next_action_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Earliest Next Action At
        paused:
          title: Paused
          type: boolean
        queued_count:
          title: Queued Count
          type: integer
      required:
        - action
        - earliest_next_action_at
        - paused
        - checkpoint
        - queued_count
        - deferred_reason
      title: AgentNextActionSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    LinkedInActionReadSchema:
      properties:
        account_id:
          format: uuid
          title: Account Id
          type: string
        claimed_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Claimed At
        duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Ms
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
        expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Expires At
        finished_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Finished At
        id:
          format: uuid
          title: Id
          type: string
        kind:
          $ref: '#/components/schemas/LinkedInActionKind'
        outcome:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Outcome
        params:
          additionalProperties: true
          title: Params
          type: object
        priority:
          title: Priority
          type: integer
        queued_at:
          format: date-time
          title: Queued At
          type: string
        source_enrolment_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Source Enrolment Id
        source_step_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Source Step Id
        status:
          $ref: '#/components/schemas/LinkedInActionStatus'
      required:
        - id
        - account_id
        - kind
        - params
        - status
        - outcome
        - error_code
        - error_message
        - priority
        - queued_at
        - claimed_at
        - finished_at
        - duration_ms
        - expires_at
        - source_enrolment_id
        - source_step_id
      title: LinkedInActionReadSchema
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
    LinkedInActionKind:
      description: >-
        What the browser agent is being asked to do.


        The three ``CHECK_*``/``READ_*`` kinds are housekeeping — they read our
        own

        outbound invitations and our own conversations to detect what the
        contact did

        — so they are free and deliberately excluded from the priced kinds
        below.


        ``CHECK_INBOX`` scans the conversation list for threads with new inbound

        activity; ``READ_CONVERSATION`` opens one of them and reads it in full.
        The

        split keeps LinkedIn activity proportional to real replies: the cheap
        scan

        runs on every sweep, the expensive read only where the scan saw a
        change.


        ``LIKE_LATEST_POST`` targets the contact's most recent post at the
        moment

        the browser runs it. A contact with no posts is not a failure: the
        driver

        reports the action ``SKIPPED``, and the sequence advances either way.


        A ``PROFILE_VIEW`` outcome MAY additionally carry ``open_profile: bool``
        —

        whether the member's Premium "Open Profile" toggle is on, read off the

        page when the driver can see it. The open-profile condition resolves
        from

        that observation and never from a guess, so a driver that cannot tell

        simply omits the key.
      enum:
        - profile_view
        - connection_request
        - send_message
        - inmail
        - withdraw_connection_request
        - follow_contact
        - like_latest_post
        - check_sent_invitations
        - check_inbox
        - read_conversation
      title: LinkedInActionKind
      type: string
    LinkedInActionStatus:
      description: >-
        Where one queued action stands.


        Governor-deferral is deliberately NOT a status: an action whose kind has
        hit

        its daily cap stays ``QUEUED`` and is simply not handed out, with the
        reason

        travelling on the hand-out response instead. A ``DEFERRED`` row would
        make

        the queue lie about what is still waiting to happen.


        ``SKIPPED`` is "not applicable" (no LinkedIn URL, already connected);

        ``REJECTED`` is "a human refused it"; ``FAILED`` is "we tried and could
        not".
      enum:
        - queued
        - claimed
        - succeeded
        - failed
        - rejected
        - skipped
      title: LinkedInActionStatus
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````