Opal

Opal In Market API

The In Market API from Opal — 1 operation(s) for in market.

GitHub OpenAPI

Operations 1

GET /{workspace_id}/in_market/calendar Get in-market calendar view #

Documentation

📖
Documentation
https://login.ouropal.com/api/documentation/v2
📖
APIReference
https://login.ouropal.com/api/documentation/v2
📖
Documentation
https://login.ouropal.com/api/documentation/v3
📖
APIReference
https://login.ouropal.com/api/documentation/v3
📖
Documentation
https://login.ouropal.com/api/documentation/asgard_bff

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-in-market-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/opal-in-market-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

opal-in-market-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 3.0.0
  title: Asgard BFF In Market API
  license:
    name: Opal API License
    url: https://www.workwithopal.com/api-license
  description: The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
servers:
- url: https://login.ouropal.com
tags:
- name: In Market
paths:
  /{workspace_id}/in_market/calendar:
    get:
      tags:
      - In Market
      operationId: ReadInMarketBFFV1
      summary: Get in-market calendar view
      description: Returns a collection of in-market Content items such that the content is currently live or scheduled to go live across a given set of filter criteria.
      security:
      - oauth2:
        - offline_access
      - api_key:
        - Session-Token
      parameters:
      - name: workspace_id
        in: path
        required: true
        description: The ID of the current workspace to pull content from.
        schema:
          type: string
          format: uuid
      - name: filter
        in: query
        description: 'Filters for limiting the results. All filter parameters are optional except workspace_id (provided in path).

          '
        required: false
        schema:
          type: object
          properties:
            account_id:
              type: array
              items:
                type: string
                format: uuid
              description: 'Filter content by comma-separated UUIDs. Matches content having the specified account UUID(s).

                '
            channel_id:
              type: array
              items:
                type: string
                format: uuid
              description: 'Filter content by comma-separated UUIDs. Matches content having the specified channel UUID(s).

                '
            label_id:
              type: array
              items:
                type: string
                format: uuid
              description: 'Filter by comma-separated UUIDs. Matches content with labels from directly assigned labels, or labels inherited from parent moment, story, or account.

                '
            label_set_id:
              type: string
              format: uuid
              description: 'Filter by comma-separated UUIDs. Matches content with labels belonging to the specified label set, from directly assigned labels or labels inherited from parent moment, story, or account.

                '
            content_statuses:
              type: array
              items:
                type: string
                enum:
                - draft
                - for_approval
                - needs_revision
                - approved
                - idea
              description: 'Filter by comma-separated content workflow statuses. The "idea" status represents moments without any content/posts and will return an empty result when used alone, or will be stripped from the filter when combined with other statuses.

                '
            scheduled_at:
              allOf:
              - type: object
                properties:
                  eq:
                    type: string
                    description: 'Equal to filter. If no other filter is specified, `eq` will be assumed.

                      '
                  gt:
                    type: string
                    description: Greater than filter
                  gteq:
                    type: string
                    description: Greater than or equal to filter
                  lt:
                    type: string
                    description: Less than filter
                  lteq:
                    type: string
                    description: Less than or equal to filter
              description: 'Filter for content that is live/in-market during the specified time period (ISO 8601 format). Supports comparison operators: `eq` (equal to), `gt` (greater than), `gteq` (greater than or equal to), lt (less than), `lteq` (less than or equal to).

                If no operator is specified, `eq` is assumed. For example, `filter[scheduled_at]=2025-01-01` is equivalent to `filter[scheduled_at][eq]=2025-01-01`.

                The `eq` operator converts a date to a 24-hour range. For example, `filter[scheduled_at][eq]=2025-01-01` is equivalent to `filter[scheduled_at][gteq]=2025-01-01T00:00:00&filter[scheduled_at][lteq]=2025-01-02T00:00:00`.

                Use `gteq` for range start and `lteq` for range end to query content scheduled within a date range.

                This endpoint always considers both start and takedown dates when filtering by date range, returning content that is live during the specified period.

                '
        style: deepObject
        explode: true
      responses:
        '200':
          description: The requested in-market content items
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: object
                    required:
                    - content
                    additionalProperties: false
                    description: 'A collection of in-market Content items. Each item contains data from the Content resource and its related resources.

                      '
                    properties:
                      content:
                        type: object
                        required:
                        - by_id
                        - list
                        additionalProperties: false
                        properties:
                          by_id:
                            type: object
                            description: 'An object where the keys are content UUIDs and values are InMarketItem objects. Keys have no guaranteed order.

                              '
                            additionalProperties:
                              type: object
                              required:
                              - id
                              - dateRangeLabel
                              - endDate
                              - momentName
                              - contentSnapshotUrl
                              - contentName
                              - contentUrl
                              - channelSystemName
                              - channelIcon
                              - startDate
                              - storyName
                              additionalProperties: false
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                  description: The UUID of the content resource.
                                dateRangeLabel:
                                  type:
                                  - string
                                  - 'null'
                                  description: 'Human-readable date range label (e.g., "Oct 1" if only a start date, "Oct 24 - Oct 31" if both start and end dates). Derived from the content''s scheduled_at and takedown_scheduled_at attributes.

                                    '
                                endDate:
                                  type:
                                  - string
                                  - 'null'
                                  format: date
                                  description: 'The date portion (YYYY-MM-DD) of the scheduled end date/time for the content (when it will be taken down). Null if no takedown is scheduled. Derived from the content''s takedown_scheduled_at attribute, which may reflect the moment''s end date if the moment is configured to cascade its end date to content. Null if the content has no explicit takedown date and the moment either has no end date or is not configured to cascade.

                                    '
                                momentName:
                                  type: string
                                  description: The title/name of the associated moment. Empty string if no moment.
                                storyName:
                                  type:
                                  - string
                                  - 'null'
                                  description: The name of the associated story. Null if no story.
                                contentSnapshotUrl:
                                  type:
                                  - string
                                  - 'null'
                                  description: URL to the default snapshot/preview image for the content. Null if no snapshot available.
                                contentName:
                                  type: string
                                  description: The name/title of the content.
                                contentUrl:
                                  type:
                                  - string
                                  - 'null'
                                  description: 'Relative URL path to the content in format: moments/{workspace_slug}/{moment_legacy_id}/posts/{post_legacy_id}. Null if any required component is missing.

                                    '
                                channelSystemName:
                                  type:
                                  - string
                                  - 'null'
                                  description: 'The system name of the social media channel (e.g., "facebook", "instagram", "twitter"). Null if no channel associated.

                                    '
                                channelIcon:
                                  type:
                                  - string
                                  - 'null'
                                startDate:
                                  type:
                                  - string
                                  - 'null'
                                  format: date
                                  description: 'The date portion (YYYY-MM-DD) of the scheduled start date/time for the content (when it goes live). Null if no schedule is set.

                                    '
                          list:
                            type: array
                            description: 'An ordered array of Content UUIDs providing the display order for items, and is sorted by the Content''s scheduled start date/time (ascending, null values first), then contentName (alphabetical). Look up items in `by_id` using the UUIDs from this list.

                              '
                            items:
                              type: string
                              format: uuid
              example:
                data:
                  content:
                    by_id:
                      bf886a14-6fdf-4c5a-95d5-6d2574ef2d06:
                        id: bf886a14-6fdf-4c5a-95d5-6d2574ef2d06
                        dateRangeLabel: Oct 24 - Oct 31
                        endDate: '2025-10-31'
                        momentName: Product Launch Campaign
                        contentSnapshotUrl: https://foo.opal.com:443/api/v1/snapshots/bf886a14-6fdf-4c5a-95d5-6d2574ef2d06
                        contentName: New Product Announcement
                        contentUrl: moments/acme-corp/13/posts/13
                        channelSystemName: facebook
                        channelIcon: facebook
                        startDate: '2025-10-24'
                        storyName: Social Media Push
                      c8997b25-7ee0-5d6b-a6e6-7e3685fa3e17:
                        id: c8997b25-7ee0-5d6b-a6e6-7e3685fa3e17
                        dateRangeLabel: Oct 25
                        endDate: null
                        momentName: Product Launch Campaign
                        contentSnapshotUrl: https://foo.opal.com:443/api/v1/snapshots/c8997b25-7ee0-5d6b-a6e6-7e3685fa3e17
                        contentName: Product Feature Highlight
                        contentUrl: moments/acme-corp/13/posts/14
                        channelSystemName: instagram
                        channelIcon: instagram
                        startDate: '2025-10-25'
                        storyName: Social Media Push
                    list:
                    - bf886a14-6fdf-4c5a-95d5-6d2574ef2d06
                    - c8997b25-7ee0-5d6b-a6e6-7e3685fa3e17
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                      required:
                      - status
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                      required:
                      - status
components:
  securitySchemes:
    api_key:
      type: apiKey
      description: (Deprecated) This API also supports authentication via an API or session token set in the request headers.
      in: header
      name: Session-Token
x-tagGroups:
- name: ⚠️  Unstable
  tags:
  - Plans
  - Blocks
  - Custom Fields
- name: ℹ️ Proposed
  tags:
  - Moments
  - Smart Blocks
  - In Market
- name: 🔮 Experimental
  tags:
  - Experimental