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

# List engagement profiles

> List all engagement-only profiles in the workspace. Engagement profiles can only be used for auto-engagements.



## OpenAPI

````yaml /api/openapi.json get /profiles/engagement
openapi: 3.1.0
info:
  title: Ordinal API
  version: 1.0.0
  description: API to create and manage Ordinal workspaces, posts, profiles, and analytics
servers:
  - url: https://app.tryordinal.com/api/v1
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Analytics
    description: Social media analytics data
  - name: Approvals
    description: Post approval workflows
  - name: Comments
    description: >-
      Post comments for team collaboration. Supports @mentions using the format
      @[Display Name](userId).
  - name: Engagements
    description: Auto-engagements for posts (likes, comments, reposts)
  - name: Invites
    description: Workspace invitations for adding new users
  - name: Labels
    description: Labels for organizing posts
  - name: Instagram
    description: Instagram utilities for location search and tagging
  - name: LinkedIn
    description: LinkedIn utilities for profile lookups, tagging, and mentions
  - name: Posts
    description: Create and manage posts
  - name: Profiles
    description: List connected social profiles
  - name: Slack Boosts
    description: >-
      List connected Slack channels (webhooks), then create and manage slack
      boosts so teams get notified in Slack when posts publish. Requires Slack
      connected with marketing boost channels.
  - name: Subscribers
    description: Post subscribers for notifications
  - name: File Uploads
    description: >-
      Upload files from URLs for use in posts. Supports images (JPEG, PNG, GIF,
      WebP) up to 10 MB and videos (MP4, MOV) up to 350 MB.
  - name: Ideas
    description: >-
      Create and manage content ideas. Ideas are draft posts without scheduled
      dates that can be converted to calendar posts.
  - name: Inline Comments
    description: >-
      Text-anchored comments on specific post content. Read-only API for
      retrieving inline comments across channels.
  - name: Users
    description: Workspace users
  - name: Webhooks
    description: >-
      Create, list, get, update, and delete webhooks to receive real-time event
      notifications
  - name: Workspaces
    description: Workspace information
paths:
  /profiles/engagement:
    get:
      tags:
        - Profiles
      summary: List engagement profiles
      description: >-
        List all engagement-only profiles in the workspace. Engagement profiles
        can only be used for auto-engagements.
      operationId: profiles-listEngagement
      responses:
        '200':
          description: List of engagement profiles
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Profile'
              example:
                - id: 550e8400-e29b-41d4-a716-446655440002
                  name: Acme Marketing
                  detail: '@acme_marketing'
                  channel: Twitter
                  profileImageUrl: https://pbs.twimg.com/profile_images/example.jpg
                  isReintegrationRequired: false
                  createdAt: '2025-07-20T14:30:00.000Z'
                  createdBy:
                    id: 550e8400-e29b-41d4-a716-446655440010
                    email: john@acme.com
                    firstName: John
                    lastName: Doe
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Profile:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
        detail:
          type: string
          nullable: true
        channel:
          $ref: '#/components/schemas/Channel'
        profileImageUrl:
          type: string
          nullable: true
        isReintegrationRequired:
          type: boolean
        createdAt:
          type: string
          format: date-time
        createdBy:
          $ref: '#/components/schemas/UserSummary'
    Channel:
      type: string
      enum:
        - LinkedIn
        - Twitter
        - Instagram
        - Facebook
        - Threads
        - TikTok
        - Discord
        - Slack
        - Webflow
        - YouTubeShorts
    UserSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Unauthorized - Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: UNAUTHORIZED
            message: Invalid or unauthorized API key
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authentication. Generate an API key from your workspace
        settings.

````