openapi: 3.2.0
info:
  title: Collections assets API
  version: 1.0.0
servers:
- url: https://{your-bynder-domain}/
tags:
- name: Collections assets
  description: ''
paths:
  /api/v4/collections/{id}/media:
    get:
      summary: Retrieve the assets of a specific collection
      description: Retrieve the assets of a specific collection by ID.
      tags:
      - Collections assets
      security:
      - OAuth2: []
      - permanentToken: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000
      responses:
        '200':
          description: A list of asset IDs.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  example: 00000000-0000-0000-0000000000000000
              examples:
                example1:
                  value:
                  - 00000000-0000-0000-0000000000000000
                  - 00000000-0000-0000-0000000000000001
                  - 00000000-0000-0000-0000000000000002
        '404':
          description: Collection not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Collection not found
                  statuscode:
                    type: integer
                    example: 404
    post:
      summary: Add assets to a collection
      description: Add assets to a specific collection by ID.
      tags:
      - Collections assets
      security:
      - OAuth2:
        - COLLECTIONS
      - permanentToken:
        - COLLECTIONS
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                data:
                  type: string
                  example: '["00000000-0000-0000-0000000000000000"]'
      responses:
        '202':
          description: Assets added to collection.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Accepted
                  statuscode:
                    type: integer
                    example: 202
        '403':
          description: Access denied.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Access denied
                  statuscode:
                    type: integer
                    example: 403
    delete:
      summary: Remove assets from a collection
      description: Remove assets from a specific collection by ID.
      tags:
      - Collections assets
      security:
      - OAuth2:
        - COLLECTIONS
      - permanentToken:
        - COLLECTIONS
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000
      - name: deleteIds
        in: query
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000
      responses:
        '204':
          description: No Content
        '403':
          description: Access denied.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Access denied
                  statuscode:
                    type: integer
                    example: 403
components:
  securitySchemes:
    permanentToken:
      type: apiKey
      in: header
      name: Authorization
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
          scopes:
            collection.public.view: To retrieve public collections
            INBOXPUBLIC: To retrieve collections other users shared/received
            OUTBOXPUBLIC: To retrieve collections other users shared/received
            PUBLICCOLLECTIONS: To retrieve collections other users created
            COLLECTIONS: ''
            PUBLISHCOLLECTIONS: ''
            SHARECOLLECTION: ''
            SHARING: ''
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
          scopes:
            collection.public.view: To retrieve public collections
            INBOXPUBLIC: To retrieve collections other users shared/received
            OUTBOXPUBLIC: To retrieve collections other users shared/received
            PUBLICCOLLECTIONS: To retrieve collections other users created
            COLLECTIONS: ''
            PUBLISHCOLLECTIONS: ''
            SHARECOLLECTION: ''
            SHARING: ''