Bynder Workflow API

The Workflow API from Bynder — 4 operation(s) for workflow.

OpenAPI Specification

bynder-workflow-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Bynder Account Workflow API
  version: '1.0'
  description: 'Bynder is a cloud-based digital asset management (DAM) platform. The

    REST API lets developers manage assets, metaproperties, collections,

    taxonomies, workflows, brand guidelines, analytics, webhooks, and

    automations.


    Authentication uses OAuth 2.0 with authorization code, client

    credentials, and refresh token flows against the customer''s portal

    domain. All calls require a Bearer access token in JWT format. The

    base URL is the customer''s portal hostname, e.g.

    `https://yourportal.bynder.com`.


    Rate limit: 4500 requests per 5-minute window per IP. Exceeding

    returns HTTP 429.

    '
  contact:
    name: Bynder Developer Portal
    url: https://developers.bynder.com
servers:
- url: https://{portal}.bynder.com
  description: Customer portal
  variables:
    portal:
      default: yourportal
      description: Customer portal subdomain
security:
- oauth2: []
tags:
- name: Workflow
paths:
  /api/workflow/campaigns:
    get:
      tags:
      - Workflow
      summary: List campaigns
      operationId: listCampaigns
      responses:
        '200':
          description: Campaigns
    post:
      tags:
      - Workflow
      summary: Create campaign
      operationId: createCampaign
      responses:
        '201':
          description: Created
  /api/workflow/campaigns/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Workflow
      summary: Retrieve campaign
      operationId: getCampaign
      responses:
        '200':
          description: Campaign
    put:
      tags:
      - Workflow
      summary: Modify campaign
      operationId: updateCampaign
      responses:
        '200':
          description: Updated
    delete:
      tags:
      - Workflow
      summary: Delete campaign
      operationId: deleteCampaign
      responses:
        '204':
          description: Deleted
  /api/workflow/jobs:
    get:
      tags:
      - Workflow
      summary: List jobs
      operationId: listJobs
      responses:
        '200':
          description: Jobs
    post:
      tags:
      - Workflow
      summary: Create job
      operationId: createJob
      responses:
        '201':
          description: Created
  /api/workflow/jobs/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Workflow
      summary: Retrieve job
      operationId: getJob
      responses:
        '200':
          description: Job
    put:
      tags:
      - Workflow
      summary: Modify job
      operationId: updateJob
      responses:
        '200':
          description: Updated
    delete:
      tags:
      - Workflow
      summary: Delete job
      operationId: deleteJob
      responses:
        '204':
          description: Deleted
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 with JWT bearer access tokens
      flows:
        authorizationCode:
          authorizationUrl: https://yourportal.bynder.com/v6/authentication/oauth2/auth
          tokenUrl: https://yourportal.bynder.com/v6/authentication/oauth2/token/authorization
          refreshUrl: https://yourportal.bynder.com/v6/authentication/oauth2/token/refresh
          scopes:
            offline: Refresh token access
            asset:read: Read assets
            asset:write: Write assets
            collection:read: Read collections
            collection:write: Write collections
            meta.assetbank:read: Read asset bank metaproperties
            meta.assetbank:write: Write asset bank metaproperties
        clientCredentials:
          tokenUrl: https://yourportal.bynder.com/v6/authentication/oauth2/token/client-credentials
          scopes:
            asset:read: Read assets
            asset:write: Write assets