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

# What these people did with which posts

> `person_id` is required: the read binds on the people, not on the workspace.



## OpenAPI

````yaml /openapi.json get /v1/engagements
openapi: 3.1.0
info:
  title: Ziplined API
  version: 1.0.0
  description: >-
    LinkedIn engagement data about people, companies and posts. The workspace
    comes from the credential; lists page with `limit` and `next_cursor`.
servers:
  - url: https://api.ziplined.io
    description: Production
security: []
tags:
  - name: People
    description: The people in your workspace, and what you sent them.
  - name: Companies
    description: The companies those people work at.
  - name: Posts
    description: Your own posts and their numbers.
  - name: Engagements
    description: One act by one person on one post.
  - name: Insights
    description: Period against period, and the series behind it.
  - name: Audiences
    description: Named lists of people, and their membership.
  - name: Sources
    description: What your radar collects from.
  - name: Integrations
    description: Webhook and Slack destinations, and routing rules.
paths:
  /v1/engagements:
    get:
      tags:
        - Engagements
      summary: What these people did with which posts
      description: >-
        `person_id` is required: the read binds on the people, not on the
        workspace.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            description: How many rows to return. Maximum 200.
          required: false
          description: How many rows to return. Maximum 200.
          name: limit
          in: query
        - schema:
            type: string
            description: 'The `next_cursor` from the previous page. Opaque: do not parse it.'
          required: false
          description: 'The `next_cursor` from the previous page. Opaque: do not parse it.'
          name: cursor
          in: query
        - schema:
            type: string
            description: Whose engagements. Comma-separated, at most 200. Required.
            example: ACoAAABcDeFgHi
          required: true
          description: Whose engagements. Comma-separated, at most 200. Required.
          name: person_id
          in: query
        - schema:
            type: string
            description: 'Only these kinds: like, comment, share.'
            example: NL,BE
          required: false
          description: 'Only these kinds: like, comment, share.'
          name: type
          in: query
        - schema:
            type: string
            description: Only what came in through these sources.
            example: NL,BE
          required: false
          description: Only what came in through these sources.
          name: source
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: Only engagements from this day or later.
            example: '2026-09-01'
          required: false
          description: Only engagements from this day or later.
          name: since
          in: query
      responses:
        '200':
          description: A page of engagements.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Engagement'
                  next_cursor:
                    type: string
                    nullable: true
                required:
                  - data
                  - next_cursor
        '400':
          description: A filter value is invalid, or this resource has no such filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Wrong workspace, or the credential lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Engagement:
      type: object
      properties:
        person_id:
          type: string
        post_id:
          type: string
        type:
          type: string
          description: like, comment or share.
        reaction_type:
          type: string
          nullable: true
        comment_text:
          type: string
          nullable: true
        engagement_urn:
          type: string
          nullable: true
        occurred_on:
          type: string
          nullable: true
          description: The UTC day, YYYY-MM-DD.
        source:
          type: string
          description: The tracked source this came in through.
        source_id:
          type: string
          nullable: true
        source_name:
          type: string
          nullable: true
        post_body:
          type: string
          nullable: true
        posted_at:
          type: string
          nullable: true
        post_likes:
          type: number
          nullable: true
        post_comments:
          type: number
          nullable: true
        post_permalink:
          type: string
          nullable: true
        post_author_person_id:
          type: string
          nullable: true
      required:
        - person_id
        - post_id
        - type
        - reaction_type
        - comment_text
        - engagement_urn
        - occurred_on
        - source
        - source_id
        - source_name
        - post_body
        - posted_at
        - post_likes
        - post_comments
        - post_permalink
        - post_author_person_id
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.