openapi: 3.0.3
info:
  title: 'API Documentation | Infinity'
  description: 'Short API Documentation for Infinity application.'
  version: 1.0.0
servers:
  -
    url: 'https://app.startinfinity.com'
paths:
  /api/v2/profile:
    get:
      summary: 'Get my profile data'
      operationId: getMyProfileData
      description: 'The response contains all the data related to the current user, including some fields that are not visible to other users.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 1302
                  object: user
                  name: 'Damian Peterson'
                  email: damianpeterson@startinfinity.com
                  photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                  created_at: '2020-11-25T15:31:38.000000Z'
                  job: null
                  location: null
                  tagline: null
                  preferences: []
                  is_developer: true
                  deleted: false
                properties:
                  id:
                    type: integer
                    example: 1302
                  object:
                    type: string
                    example: user
                  name:
                    type: string
                    example: 'Damian Peterson'
                  email:
                    type: string
                    example: damianpeterson@startinfinity.com
                  photo_url:
                    type: string
                    example: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                  created_at:
                    type: string
                    example: '2020-11-25T15:31:38.000000Z'
                  job:
                    type: string
                    example: null
                  location:
                    type: string
                    example: null
                  tagline:
                    type: string
                    example: null
                  preferences:
                    type: array
                    example: []
                  is_developer:
                    type: boolean
                    example: true
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Profile
  /api/v2/workspaces:
    get:
      summary: 'List workspaces'
      operationId: listWorkspaces
      description: 'Lists all workspaces that belong to the currently logged-in user.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: NjY5LDIwMjAtMTEtMjUgMTU6MzI6Mzg=
                  after: NjY5LDIwMjAtMTEtMjUgMTU6MzI6Mzg=
                  data:
                    -
                      id: 669
                      object: workspace
                      name: 'Customer Success'
                      photo_url: null
                      owner_id: 1302
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: NjY5LDIwMjAtMTEtMjUgMTU6MzI6Mzg=
                  after:
                    type: string
                    example: NjY5LDIwMjAtMTEtMjUgMTU6MzI6Mzg=
                  data:
                    type: array
                    example:
                      -
                        id: 669
                        object: workspace
                        name: 'Customer Success'
                        photo_url: null
                        owner_id: 1302
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 669
                        object:
                          type: string
                          example: workspace
                        name:
                          type: string
                          example: 'Customer Success'
                        photo_url:
                          type: string
                          example: null
                        owner_id:
                          type: integer
                          example: 1302
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Workspaces
  '/api/v2/workspaces/{workspace}/boards':
    get:
      summary: 'List boards'
      operationId: listBoards
      description: 'Lists all boards that belong to the workspace given.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: TEExZFc4aTFUVEssMjAyMC0xMS0yNSAxNTozMjozOA==
                  after: TEExZFc4aTFUVEssMjAyMC0xMS0yNSAxNTozMjozOA==
                  data:
                    -
                      id: LA1dW8i1TTK
                      object: board
                      name: 'Vacation Planning'
                      sort_order: '393216.000000000000000000000000000000'
                      color: '#4eb4f9'
                      description: null
                      og_image: null
                      user_ids: []
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: TEExZFc4aTFUVEssMjAyMC0xMS0yNSAxNTozMjozOA==
                  after:
                    type: string
                    example: TEExZFc4aTFUVEssMjAyMC0xMS0yNSAxNTozMjozOA==
                  data:
                    type: array
                    example:
                      -
                        id: LA1dW8i1TTK
                        object: board
                        name: 'Vacation Planning'
                        sort_order: '393216.000000000000000000000000000000'
                        color: '#4eb4f9'
                        description: null
                        og_image: null
                        user_ids: []
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: LA1dW8i1TTK
                        object:
                          type: string
                          example: board
                        name:
                          type: string
                          example: 'Vacation Planning'
                        sort_order:
                          type: string
                          example: '393216.000000000000000000000000000000'
                        color:
                          type: string
                          example: '#4eb4f9'
                        description:
                          type: string
                          example: null
                        og_image:
                          type: string
                          example: null
                        user_ids:
                          type: array
                          example: []
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Boards
    post:
      summary: 'Create board'
      operationId: createBoard
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: KtZ2cZnMtoR
                  object: board
                  name: 'Development Tasks'
                  sort_order: '458752.000000000000000000000000000000'
                  color: '#f57740'
                  description: 'Product Development board'
                  og_image: null
                  user_ids:
                    - 1302
                  deleted: false
                properties:
                  id:
                    type: string
                    example: KtZ2cZnMtoR
                  object:
                    type: string
                    example: board
                  name:
                    type: string
                    example: 'Development Tasks'
                  sort_order:
                    type: string
                    example: '458752.000000000000000000000000000000'
                  color:
                    type: string
                    example: '#f57740'
                  description:
                    type: string
                    example: 'Product Development board'
                  og_image:
                    type: string
                    example: null
                  user_ids:
                    type: array
                    example:
                      - 1302
                    items:
                      type: integer
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Boards
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: ''
                  example: 'Development Tasks'
                description:
                  type: string
                  description: ''
                  example: 'Product Development board'
                color:
                  type: string
                  description: 'Board color in the HEX format.'
                  example: '#f57740'
                user_ids:
                  type: array
                  description: 'Ids of the workspace members that will have board access. Current user will be added automatically'
                  example: []
                  items:
                    type: integer
              required:
                - name
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}':
    get:
      summary: 'Get board'
      operationId: getBoard
      description: "Get a single board by its id for the board given. The user needs to have access to the board\nin order to be able to fetch it."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: LA1dW8i1TTK
                  object: board
                  name: 'Vacation Planning'
                  sort_order: '393216.000000000000000000000000000000'
                  color: '#4eb4f9'
                  description: null
                  og_image: null
                  user_ids: []
                  deleted: false
                properties:
                  id:
                    type: string
                    example: LA1dW8i1TTK
                  object:
                    type: string
                    example: board
                  name:
                    type: string
                    example: 'Vacation Planning'
                  sort_order:
                    type: string
                    example: '393216.000000000000000000000000000000'
                  color:
                    type: string
                    example: '#4eb4f9'
                  description:
                    type: string
                    example: null
                  og_image:
                    type: string
                    example: null
                  user_ids:
                    type: array
                    example: []
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Boards
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/attributes':
    get:
      summary: 'List attributes'
      operationId: listAttributes
      description: "Lists all attributes belonging to the board given. The user needs to have access\nto the board in order to be able to fetch its attributes."
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: true
                  before: YjVlOTVlYzgtODBiYy00YTU1LWE5OTYtZGNlYTY2M2U0ZTZjLDIwMjEtMTItMTUgMTI6MjQ6NDQ=
                  after: NDZiMTcxYzUtMzJmYS00YmQ4LWIyM2EtZjJiZjQ2NDU2MzJjLDIwMjAtMTEtMjYgMTM6NTc6MTE=
                  data:
                    -
                      id: b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                      object: attribute
                      name: Reference
                      type: reference
                      default_data: null
                      settings:
                        folderId: 8FjZofz89PM
                      created_by: 1302
                      created_at: '2021-12-15T12:24:44.000000Z'
                      deleted: false
                    -
                      id: e3009b98-db05-4408-8414-c8ce5cd7c143
                      object: attribute
                      name: Cuisine
                      type: label
                      default_data: []
                      settings:
                        multiple: true
                        allowNew: true
                        allowEmpty: true
                        labels:
                          -
                            id: 3f68e105-d878-40d9-8e51-5919d92ab89d
                            name: Spanish
                            color: '#92F3EC'
                          -
                            id: 6bc19250-f233-4a6d-9ef7-620192b4147c
                            name: Italian
                            color: '#D6C2FF'
                          -
                            id: 5627cb6f-ef56-4972-8b67-ff899fa968b4
                            name: Mexican
                            color: '#FFA2A2'
                          -
                            id: 4f539a01-28ee-4d3c-867e-7cf92c9a0ef5
                            name: Japanese
                            color: '#F3B2EA'
                          -
                            id: a7281c82-9fa4-4267-8bdf-beb25bdf0b88
                            name: Seafood
                            color: '#B3EC8D'
                      created_by: 1299
                      created_at: '2020-11-26T13:57:11.000000Z'
                      deleted: false
                    -
                      id: d2be0368-c5cd-43da-ae32-20a41304e9b1
                      object: attribute
                      name: Image
                      type: attachments
                      default_data: []
                      settings: []
                      created_by: 1299
                      created_at: '2020-11-26T13:57:11.000000Z'
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: true
                  before:
                    type: string
                    example: YjVlOTVlYzgtODBiYy00YTU1LWE5OTYtZGNlYTY2M2U0ZTZjLDIwMjEtMTItMTUgMTI6MjQ6NDQ=
                  after:
                    type: string
                    example: NDZiMTcxYzUtMzJmYS00YmQ4LWIyM2EtZjJiZjQ2NDU2MzJjLDIwMjAtMTEtMjYgMTM6NTc6MTE=
                  data:
                    type: array
                    example:
                      -
                        id: b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                        object: attribute
                        name: Reference
                        type: reference
                        default_data: null
                        settings:
                          folderId: 8FjZofz89PM
                        created_by: 1302
                        created_at: '2021-12-15T12:24:44.000000Z'
                        deleted: false
                      -
                        id: e3009b98-db05-4408-8414-c8ce5cd7c143
                        object: attribute
                        name: Cuisine
                        type: label
                        default_data: []
                        settings:
                          multiple: true
                          allowNew: true
                          allowEmpty: true
                          labels:
                            -
                              id: 3f68e105-d878-40d9-8e51-5919d92ab89d
                              name: Spanish
                              color: '#92F3EC'
                            -
                              id: 6bc19250-f233-4a6d-9ef7-620192b4147c
                              name: Italian
                              color: '#D6C2FF'
                            -
                              id: 5627cb6f-ef56-4972-8b67-ff899fa968b4
                              name: Mexican
                              color: '#FFA2A2'
                            -
                              id: 4f539a01-28ee-4d3c-867e-7cf92c9a0ef5
                              name: Japanese
                              color: '#F3B2EA'
                            -
                              id: a7281c82-9fa4-4267-8bdf-beb25bdf0b88
                              name: Seafood
                              color: '#B3EC8D'
                        created_by: 1299
                        created_at: '2020-11-26T13:57:11.000000Z'
                        deleted: false
                      -
                        id: d2be0368-c5cd-43da-ae32-20a41304e9b1
                        object: attribute
                        name: Image
                        type: attachments
                        default_data: []
                        settings: []
                        created_by: 1299
                        created_at: '2020-11-26T13:57:11.000000Z'
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                        object:
                          type: string
                          example: attribute
                        name:
                          type: string
                          example: Reference
                        type:
                          type: string
                          example: reference
                        default_data:
                          type: string
                          example: null
                        settings:
                          type: object
                          properties:
                            folderId:
                              type: string
                              example: 8FjZofz89PM
                        created_by:
                          type: integer
                          example: 1302
                        created_at:
                          type: string
                          example: '2021-12-15T12:24:44.000000Z'
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Attributes
    post:
      summary: 'Create attribute'
      operationId: createAttribute
      description: 'After the attribute is created, it is necessary to update the attribute_ids property of the Folder to make it accessible.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 018fbf52-8009-716d-85cb-510b45304451
                  object: attribute
                  name: enim
                  type: number
                  default_data: 0
                  settings:
                    delimiter: .
                  created_by: 1302
                  created_at: '2024-05-28T13:10:06.000000Z'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 018fbf52-8009-716d-85cb-510b45304451
                  object:
                    type: string
                    example: attribute
                  name:
                    type: string
                    example: enim
                  type:
                    type: string
                    example: number
                  default_data:
                    type: integer
                    example: 0
                  settings:
                    type: object
                    properties:
                      delimiter:
                        type: string
                        example: .
                  created_by:
                    type: integer
                    example: 1302
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:06.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Attributes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: ''
                  example: enim
                type:
                  type: string
                  description: 'Available types: `attachments`, `checkbox`, `created_at`, `created_by`, `date`, `email`, `label`, `links`, `longtext`, `members`, `number`, `phone`, `progress`, `rating`, `source_folder`, `text`, `updated_at`, `vote`'
                  example: number
                default_data:
                  type: string
                  description: 'Default data should be valid value for a given Attribute Type.'
                  example: '0'
                settings:
                  type: object
                  description: 'Depending on the Attribute Type, settings will have different parameters.'
                  example: []
                  properties:
                    delimiter:
                      type: string
                      description: .
                      example: .
              required:
                - name
                - type
                - default_data
                - settings
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/attributes/{attribute}':
    get:
      summary: 'Get attribute'
      operationId: getAttribute
      description: "Get a single attribute by its id for the board given. The user needs to have access to the board\nin order to be able to fetch an attribute."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                  object: attribute
                  name: Price
                  type: label
                  default_data: []
                  settings:
                    multiple: true
                    allowNew: true
                    allowEmpty: true
                    labels:
                      -
                        id: d271b2b3-4ccc-43cd-8628-5861d2151eb6
                        name: $
                        color: '#92F3EC'
                      -
                        id: 7a9bd039-f9a4-4da6-8e95-d356d6dc44f8
                        name: $$
                        color: '#FFD3F2'
                      -
                        id: 7018cc1a-366a-4b76-8a17-6b70fd9a9709
                        name: $$$
                        color: '#FFE197'
                      -
                        id: 0f1fef0b-5ae6-4864-b1d2-e1ccf8423154
                        name: $$$$
                        color: '#D6C2FF'
                  created_by: 1299
                  created_at: '2020-11-26T13:57:11.000000Z'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                  object:
                    type: string
                    example: attribute
                  name:
                    type: string
                    example: Price
                  type:
                    type: string
                    example: label
                  default_data:
                    type: array
                    example: []
                  settings:
                    type: object
                    properties:
                      multiple:
                        type: boolean
                        example: true
                      allowNew:
                        type: boolean
                        example: true
                      allowEmpty:
                        type: boolean
                        example: true
                      labels:
                        type: array
                        example:
                          -
                            id: d271b2b3-4ccc-43cd-8628-5861d2151eb6
                            name: $
                            color: '#92F3EC'
                          -
                            id: 7a9bd039-f9a4-4da6-8e95-d356d6dc44f8
                            name: $$
                            color: '#FFD3F2'
                          -
                            id: 7018cc1a-366a-4b76-8a17-6b70fd9a9709
                            name: $$$
                            color: '#FFE197'
                          -
                            id: 0f1fef0b-5ae6-4864-b1d2-e1ccf8423154
                            name: $$$$
                            color: '#D6C2FF'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: d271b2b3-4ccc-43cd-8628-5861d2151eb6
                            name:
                              type: string
                              example: $
                            color:
                              type: string
                              example: '#92F3EC'
                  created_by:
                    type: integer
                    example: 1299
                  created_at:
                    type: string
                    example: '2020-11-26T13:57:11.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Attributes
    put:
      summary: 'Update attribute'
      operationId: updateAttribute
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                  object: attribute
                  name: ea
                  type: number
                  default_data: 0
                  settings:
                    delimiter: .
                  created_by: 1299
                  created_at: '2020-11-26T13:57:11.000000Z'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                  object:
                    type: string
                    example: attribute
                  name:
                    type: string
                    example: ea
                  type:
                    type: string
                    example: number
                  default_data:
                    type: integer
                    example: 0
                  settings:
                    type: object
                    properties:
                      delimiter:
                        type: string
                        example: .
                  created_by:
                    type: integer
                    example: 1299
                  created_at:
                    type: string
                    example: '2020-11-26T13:57:11.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Attributes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Attribute name'
                  example: ea
                type:
                  type: string
                  description: 'Available types: `attachments`, `checkbox`, `created_at`, `created_by`, `date`, `email`, `label`, `links`, `longtext`, `members`, `number`, `phone`, `progress`, `rating`, `source_folder`, `text`, `updated_at`, `vote`'
                  example: number
                default_data:
                  type: string
                  description: 'Default data should be valid value for a given Attribute Type.'
                  example: '0'
                settings:
                  type: object
                  description: 'Depending on the Attribute Type, settings will have different parameters.'
                  example: []
                  properties:
                    delimiter:
                      type: string
                      description: .
                      example: .
              required:
                - name
                - type
                - default_data
                - settings
    delete:
      summary: 'Delete attribute'
      operationId: deleteAttribute
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                  object: attribute
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                  object:
                    type: string
                    example: attribute
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Attributes
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
      -
        in: path
        name: attribute
        description: 'Attribute ID'
        example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/items':
    get:
      summary: 'List items'
      operationId: listItems
      description: 'Lists paginated items. Item properties can be expanded.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: query
          name: expand
          description: 'expand response with sub-models. Possible options `values`, `values.attribute`, `created_by`, `folder` . Must be one of <code>values</code>, <code>values.attribute</code>, <code>folder</code>, or <code>created_by</code>.'
          example:
            - values.attribute
          required: false
          schema:
            type: array
            description: 'expand response with sub-models. Possible options `values`, `values.attribute`, `created_by`, `folder` . Must be one of <code>values</code>, <code>values.attribute</code>, <code>folder</code>, or <code>created_by</code>.'
            example:
              - values.attribute
            items:
              type: string
        -
          in: query
          name: folder_id
          description: 'Filter items by folder id.'
          example: APwqfkShQuR
          required: false
          schema:
            type: string
            description: 'Filter items by folder id.'
            example: APwqfkShQuR
        -
          in: query
          name: q
          description: 'Search items by the keyword, it will search by all attribute types giving priority to text value types.'
          example: pair
          required: false
          schema:
            type: string
            description: 'Search items by the keyword, it will search by all attribute types giving priority to text value types.'
            example: pair
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: YzQ2NzA2NzItMDNlMC00YjMyLThiMGUtY2NmNGVlMjBjYTVhLDIwMjAtMTEtMjYgMTM6NTc6MTE=
                  after: YzQ2NzA2NzItMDNlMC00YjMyLThiMGUtY2NmNGVlMjBjYTVhLDIwMjAtMTEtMjYgMTM6NTc6MTE=
                  data:
                    -
                      id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                      object: item
                      folder_id: APwqfkShQuR
                      parent_id: null
                      created_at: '2020-11-26T13:57:11.000000Z'
                      sort_order: '1442304.000000000000000000000000000000'
                      values:
                        -
                          id: 7abbf97c-a53a-420c-a947-a6e728ec2fec
                          object: value
                          data:
                            -
                              id: dd3493a6-0d22-4c02-8c3e-aa045641caac
                              name: '6 T-shirts'
                              done: false
                            -
                              id: 6dc9f3d1-f768-4cae-8f10-4fee61788f8f
                              name: '3 skirts'
                              done: false
                            -
                              id: fc101e1d-49d0-43f2-93f7-d7aaa321b77d
                              name: '1 dress'
                              done: false
                            -
                              id: 20464107-fc21-4301-b172-e56d8ab12031
                              name: '2 pairs of pants'
                              done: false
                            -
                              id: f6b2f289-600a-4e36-ab87-bf7384524e2c
                              name: '7 pairs of undies'
                              done: false
                            -
                              id: 1915e109-7c67-4f11-afa4-0c4e40e45120
                              name: '2 pairs of shoes'
                              done: false
                          attribute_id: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                          item_id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                          attribute:
                            id: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                            object: attribute
                            name: Checklist
                            type: checklist
                            default_data: []
                            settings: []
                            created_by: 1299
                            created_at: '2020-11-26T13:57:11.000000Z'
                            deleted: false
                          deleted: false
                        -
                          id: 1df86461-d6e5-4772-b447-7ff5bba22fa1
                          object: value
                          data: 'Pack the suitcase'
                          attribute_id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                          item_id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                          attribute:
                            id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                            object: attribute
                            name: Name
                            type: text
                            default_data: ''
                            settings: []
                            created_by: null
                            created_at: '2020-11-25T15:32:39.000000Z'
                            deleted: false
                          deleted: false
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: YzQ2NzA2NzItMDNlMC00YjMyLThiMGUtY2NmNGVlMjBjYTVhLDIwMjAtMTEtMjYgMTM6NTc6MTE=
                  after:
                    type: string
                    example: YzQ2NzA2NzItMDNlMC00YjMyLThiMGUtY2NmNGVlMjBjYTVhLDIwMjAtMTEtMjYgMTM6NTc6MTE=
                  data:
                    type: array
                    example:
                      -
                        id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                        object: item
                        folder_id: APwqfkShQuR
                        parent_id: null
                        created_at: '2020-11-26T13:57:11.000000Z'
                        sort_order: '1442304.000000000000000000000000000000'
                        values:
                          -
                            id: 7abbf97c-a53a-420c-a947-a6e728ec2fec
                            object: value
                            data:
                              -
                                id: dd3493a6-0d22-4c02-8c3e-aa045641caac
                                name: '6 T-shirts'
                                done: false
                              -
                                id: 6dc9f3d1-f768-4cae-8f10-4fee61788f8f
                                name: '3 skirts'
                                done: false
                              -
                                id: fc101e1d-49d0-43f2-93f7-d7aaa321b77d
                                name: '1 dress'
                                done: false
                              -
                                id: 20464107-fc21-4301-b172-e56d8ab12031
                                name: '2 pairs of pants'
                                done: false
                              -
                                id: f6b2f289-600a-4e36-ab87-bf7384524e2c
                                name: '7 pairs of undies'
                                done: false
                              -
                                id: 1915e109-7c67-4f11-afa4-0c4e40e45120
                                name: '2 pairs of shoes'
                                done: false
                            attribute_id: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                            item_id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                            attribute:
                              id: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                              object: attribute
                              name: Checklist
                              type: checklist
                              default_data: []
                              settings: []
                              created_by: 1299
                              created_at: '2020-11-26T13:57:11.000000Z'
                              deleted: false
                            deleted: false
                          -
                            id: 1df86461-d6e5-4772-b447-7ff5bba22fa1
                            object: value
                            data: 'Pack the suitcase'
                            attribute_id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                            item_id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                            attribute:
                              id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                              object: attribute
                              name: Name
                              type: text
                              default_data: ''
                              settings: []
                              created_by: null
                              created_at: '2020-11-25T15:32:39.000000Z'
                              deleted: false
                            deleted: false
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                        object:
                          type: string
                          example: item
                        folder_id:
                          type: string
                          example: APwqfkShQuR
                        parent_id:
                          type: string
                          example: null
                        created_at:
                          type: string
                          example: '2020-11-26T13:57:11.000000Z'
                        sort_order:
                          type: string
                          example: '1442304.000000000000000000000000000000'
                        values:
                          type: array
                          example:
                            -
                              id: 7abbf97c-a53a-420c-a947-a6e728ec2fec
                              object: value
                              data:
                                -
                                  id: dd3493a6-0d22-4c02-8c3e-aa045641caac
                                  name: '6 T-shirts'
                                  done: false
                                -
                                  id: 6dc9f3d1-f768-4cae-8f10-4fee61788f8f
                                  name: '3 skirts'
                                  done: false
                                -
                                  id: fc101e1d-49d0-43f2-93f7-d7aaa321b77d
                                  name: '1 dress'
                                  done: false
                                -
                                  id: 20464107-fc21-4301-b172-e56d8ab12031
                                  name: '2 pairs of pants'
                                  done: false
                                -
                                  id: f6b2f289-600a-4e36-ab87-bf7384524e2c
                                  name: '7 pairs of undies'
                                  done: false
                                -
                                  id: 1915e109-7c67-4f11-afa4-0c4e40e45120
                                  name: '2 pairs of shoes'
                                  done: false
                              attribute_id: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                              item_id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                              attribute:
                                id: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                                object: attribute
                                name: Checklist
                                type: checklist
                                default_data: []
                                settings: []
                                created_by: 1299
                                created_at: '2020-11-26T13:57:11.000000Z'
                                deleted: false
                              deleted: false
                            -
                              id: 1df86461-d6e5-4772-b447-7ff5bba22fa1
                              object: value
                              data: 'Pack the suitcase'
                              attribute_id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                              item_id: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                              attribute:
                                id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                                object: attribute
                                name: Name
                                type: text
                                default_data: ''
                                settings: []
                                created_by: null
                                created_at: '2020-11-25T15:32:39.000000Z'
                                deleted: false
                              deleted: false
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 7abbf97c-a53a-420c-a947-a6e728ec2fec
                              object:
                                type: string
                                example: value
                              data:
                                type: array
                                example:
                                  -
                                    id: dd3493a6-0d22-4c02-8c3e-aa045641caac
                                    name: '6 T-shirts'
                                    done: false
                                  -
                                    id: 6dc9f3d1-f768-4cae-8f10-4fee61788f8f
                                    name: '3 skirts'
                                    done: false
                                  -
                                    id: fc101e1d-49d0-43f2-93f7-d7aaa321b77d
                                    name: '1 dress'
                                    done: false
                                  -
                                    id: 20464107-fc21-4301-b172-e56d8ab12031
                                    name: '2 pairs of pants'
                                    done: false
                                  -
                                    id: f6b2f289-600a-4e36-ab87-bf7384524e2c
                                    name: '7 pairs of undies'
                                    done: false
                                  -
                                    id: 1915e109-7c67-4f11-afa4-0c4e40e45120
                                    name: '2 pairs of shoes'
                                    done: false
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: dd3493a6-0d22-4c02-8c3e-aa045641caac
                                    name:
                                      type: string
                                      example: '6 T-shirts'
                                    done:
                                      type: boolean
                                      example: false
                              attribute_id:
                                type: string
                                example: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                              item_id:
                                type: string
                                example: c4670672-03e0-4b32-8b0e-ccf4ee20ca5a
                              attribute:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                                  object:
                                    type: string
                                    example: attribute
                                  name:
                                    type: string
                                    example: Checklist
                                  type:
                                    type: string
                                    example: checklist
                                  default_data:
                                    type: array
                                    example: []
                                  settings:
                                    type: array
                                    example: []
                                  created_by:
                                    type: integer
                                    example: 1299
                                  created_at:
                                    type: string
                                    example: '2020-11-26T13:57:11.000000Z'
                                  deleted:
                                    type: boolean
                                    example: false
                              deleted:
                                type: boolean
                                example: false
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Items
    post:
      summary: 'Create item'
      operationId: createItem
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: faf5f6d6-6640-4f04-badf-7487db14ffca
                  object: item
                  folder_id: APwqfkShQuR
                  parent_id: null
                  created_at: '2024-05-28T13:10:06.000000Z'
                  sort_order: 2233344
                  deleted: false
                properties:
                  id:
                    type: string
                    example: faf5f6d6-6640-4f04-badf-7487db14ffca
                  object:
                    type: string
                    example: item
                  folder_id:
                    type: string
                    example: APwqfkShQuR
                  parent_id:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:06.000000Z'
                  sort_order:
                    type: integer
                    example: 2233344
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Items
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                folder_id:
                  type: string
                  description: ''
                  example: APwqfkShQuR
                values:
                  type: object
                  description: ''
                  example: []
                  properties:
                    attribute_id:
                      type: string
                      description: ''
                      example: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                    data:
                      type: string
                      description: ''
                      example: test
                parent_id:
                  type: string
                  description: 'optional Example:'
                  example: null
              required:
                - folder_id
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/items/{item}':
    get:
      summary: 'Get item'
      operationId: getItem
      description: 'Get item by its id. The item must belong to the board given. Item properties can be expanded.'
      parameters:
        -
          in: query
          name: expand
          description: 'expand response with sub-models. Possible options `values`, `values.attribute`, `created_by`, `folder`'
          example:
            - values.attribute
          required: false
          schema:
            type: array
            description: 'expand response with sub-models. Possible options `values`, `values.attribute`, `created_by`, `folder`'
            example:
              - values.attribute
            items:
              type: string
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                  object: item
                  folder_id: APwqfkShQuR
                  parent_id: null
                  created_at: '2020-11-26T13:57:11.000000Z'
                  sort_order: '852480.000000000000000000000000000000'
                  values:
                    -
                      id: 1990ccd8-6f39-41f9-85f9-a41d05112415
                      object: value
                      data: true
                      attribute_id: 3f723f19-5494-484b-a052-716d448c7629
                      item_id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                      attribute:
                        id: 3f723f19-5494-484b-a052-716d448c7629
                        object: attribute
                        name: Done
                        type: checkbox
                        default_data: false
                        settings: []
                        created_by: 1299
                        created_at: '2020-11-26T13:57:11.000000Z'
                        deleted: false
                      deleted: false
                    -
                      id: 771ed5da-ed2e-419e-a310-db013c3d0968
                      object: value
                      data: 'Choose the dates'
                      attribute_id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                      item_id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                      attribute:
                        id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                        object: attribute
                        name: Name
                        type: text
                        default_data: ''
                        settings: []
                        created_by: null
                        created_at: '2020-11-25T15:32:39.000000Z'
                        deleted: false
                      deleted: false
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                  object:
                    type: string
                    example: item
                  folder_id:
                    type: string
                    example: APwqfkShQuR
                  parent_id:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2020-11-26T13:57:11.000000Z'
                  sort_order:
                    type: string
                    example: '852480.000000000000000000000000000000'
                  values:
                    type: array
                    example:
                      -
                        id: 1990ccd8-6f39-41f9-85f9-a41d05112415
                        object: value
                        data: true
                        attribute_id: 3f723f19-5494-484b-a052-716d448c7629
                        item_id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                        attribute:
                          id: 3f723f19-5494-484b-a052-716d448c7629
                          object: attribute
                          name: Done
                          type: checkbox
                          default_data: false
                          settings: []
                          created_by: 1299
                          created_at: '2020-11-26T13:57:11.000000Z'
                          deleted: false
                        deleted: false
                      -
                        id: 771ed5da-ed2e-419e-a310-db013c3d0968
                        object: value
                        data: 'Choose the dates'
                        attribute_id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                        item_id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                        attribute:
                          id: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                          object: attribute
                          name: Name
                          type: text
                          default_data: ''
                          settings: []
                          created_by: null
                          created_at: '2020-11-25T15:32:39.000000Z'
                          deleted: false
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 1990ccd8-6f39-41f9-85f9-a41d05112415
                        object:
                          type: string
                          example: value
                        data:
                          type: boolean
                          example: true
                        attribute_id:
                          type: string
                          example: 3f723f19-5494-484b-a052-716d448c7629
                        item_id:
                          type: string
                          example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                        attribute:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 3f723f19-5494-484b-a052-716d448c7629
                            object:
                              type: string
                              example: attribute
                            name:
                              type: string
                              example: Done
                            type:
                              type: string
                              example: checkbox
                            default_data:
                              type: boolean
                              example: false
                            settings:
                              type: array
                              example: []
                            created_by:
                              type: integer
                              example: 1299
                            created_at:
                              type: string
                              example: '2020-11-26T13:57:11.000000Z'
                            deleted:
                              type: boolean
                              example: false
                        deleted:
                          type: boolean
                          example: false
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Items
    put:
      summary: 'Update item'
      operationId: updateItem
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                  object: item
                  folder_id: APwqfkShQuR
                  parent_id: sunt
                  created_at: '2020-11-26T13:57:11.000000Z'
                  sort_order: '852480.000000000000000000000000000000'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                  object:
                    type: string
                    example: item
                  folder_id:
                    type: string
                    example: APwqfkShQuR
                  parent_id:
                    type: string
                    example: sunt
                  created_at:
                    type: string
                    example: '2020-11-26T13:57:11.000000Z'
                  sort_order:
                    type: string
                    example: '852480.000000000000000000000000000000'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Items
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                folder_id:
                  type: string.
                  description: ''
                  example: APwqfkShQuR
                values:
                  type: object
                  description: ''
                  example: []
                  properties:
                    attribute_id:
                      type: string.
                      description: ''
                      example: e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                    data:
                      type: string.
                      description: ''
                      example: test2
                parent_id:
                  type: string
                  description: ''
                  example: sunt
    delete:
      summary: 'Delete item'
      operationId: deleteItem
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                  object: item
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
                  object:
                    type: string
                    example: item
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Items
    parameters:
      -
        in: path
        name: item
        description: 'Item ID'
        example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
        required: true
        schema:
          type: string
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/items/{item}/values/{value}':
    delete:
      summary: 'Delete Value'
      operationId: deleteValue
      description: 'Delete Value'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 1990ccd8-6f39-41f9-85f9-a41d05112415
                  object: value
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 1990ccd8-6f39-41f9-85f9-a41d05112415
                  object:
                    type: string
                    example: value
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Items
    parameters:
      -
        in: path
        name: item
        description: 'Item ID'
        example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
        required: true
        schema:
          type: string
      -
        in: path
        name: value
        description: 'Value ID'
        example: 1990ccd8-6f39-41f9-85f9-a41d05112415
        required: true
        schema:
          type: string
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/items/{item}/comments':
    get:
      summary: 'List comments'
      operationId: listComments
      description: "Lists the comments of the board and item given.\nComment's property 'created_by' can be included in the response's body by using the 'expand' query parameter."
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: query
          name: expand
          description: 'expand response with sub-models. Possible options `item`, `item.values` and `created_by`'
          example: null
          required: false
          schema:
            type: array
            description: 'expand response with sub-models. Possible options `item`, `item.values` and `created_by`'
            example: null
            items:
              type: string
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: YmZlZmVjN2UtNWJhNi00Mjg3LWFjNGEtNzUzMzU3NTg0ZjE2LDIwMjAtMTEtMjYgMTQ6MDI6Mjc=
                  after: YmZlZmVjN2UtNWJhNi00Mjg3LWFjNGEtNzUzMzU3NTg0ZjE2LDIwMjAtMTEtMjYgMTQ6MDI6Mjc=
                  data:
                    -
                      id: bfefec7e-5ba6-4287-ac4a-753357584f16
                      object: comment
                      parent_id: null
                      text: '<p>Reminder to myself: Check the calendar</p>'
                      created_at: '2020-11-26T14:02:27.000000Z'
                      created_by: 1302
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: YmZlZmVjN2UtNWJhNi00Mjg3LWFjNGEtNzUzMzU3NTg0ZjE2LDIwMjAtMTEtMjYgMTQ6MDI6Mjc=
                  after:
                    type: string
                    example: YmZlZmVjN2UtNWJhNi00Mjg3LWFjNGEtNzUzMzU3NTg0ZjE2LDIwMjAtMTEtMjYgMTQ6MDI6Mjc=
                  data:
                    type: array
                    example:
                      -
                        id: bfefec7e-5ba6-4287-ac4a-753357584f16
                        object: comment
                        parent_id: null
                        text: '<p>Reminder to myself: Check the calendar</p>'
                        created_at: '2020-11-26T14:02:27.000000Z'
                        created_by: 1302
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: bfefec7e-5ba6-4287-ac4a-753357584f16
                        object:
                          type: string
                          example: comment
                        parent_id:
                          type: string
                          example: null
                        text:
                          type: string
                          example: '<p>Reminder to myself: Check the calendar</p>'
                        created_at:
                          type: string
                          example: '2020-11-26T14:02:27.000000Z'
                        created_by:
                          type: integer
                          example: 1302
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Comments
    post:
      summary: 'Create comment'
      operationId: createComment
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 018fbf52-81e6-7026-9d1f-aff46bbb9133
                  object: comment
                  parent_id: null
                  text: '<p>Hello Everyone!</p>'
                  created_at: '2024-05-28T13:10:06.000000Z'
                  created_by: 1302
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 018fbf52-81e6-7026-9d1f-aff46bbb9133
                  object:
                    type: string
                    example: comment
                  parent_id:
                    type: string
                    example: null
                  text:
                    type: string
                    example: '<p>Hello Everyone!</p>'
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:06.000000Z'
                  created_by:
                    type: integer
                    example: 1302
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Comments
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'The body of the comment, it can be in the HTML format.'
                  example: '<p>Hello Everyone!</p>'
                parent_id:
                  type: parent
                  description: 'comment id'
                  example: null
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
      -
        in: path
        name: item
        description: 'Item ID'
        example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/items/{item}/comments/{comment}':
    get:
      summary: 'Get comment'
      operationId: getComment
      description: "Get comment by its id. The comment must belong to the board and item given.\nComment's property 'created_by' can be included in the response's body by using the 'expand' query parameter."
      parameters:
        -
          in: query
          name: expand
          description: 'expand response with sub-models. Possible options `item`, `item.values` and `created_by`'
          example: null
          required: false
          schema:
            type: array
            description: 'expand response with sub-models. Possible options `item`, `item.values` and `created_by`'
            example: null
            items:
              type: string
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: bfefec7e-5ba6-4287-ac4a-753357584f16
                  object: comment
                  parent_id: null
                  text: '<p>Reminder to myself: Check the calendar</p>'
                  created_at: '2020-11-26T14:02:27.000000Z'
                  created_by: 1302
                  deleted: false
                properties:
                  id:
                    type: string
                    example: bfefec7e-5ba6-4287-ac4a-753357584f16
                  object:
                    type: string
                    example: comment
                  parent_id:
                    type: string
                    example: null
                  text:
                    type: string
                    example: '<p>Reminder to myself: Check the calendar</p>'
                  created_at:
                    type: string
                    example: '2020-11-26T14:02:27.000000Z'
                  created_by:
                    type: integer
                    example: 1302
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Comments
    put:
      summary: 'Update comment'
      operationId: updateComment
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: bfefec7e-5ba6-4287-ac4a-753357584f16
                  object: comment
                  parent_id: null
                  text: eaque
                  created_at: '2020-11-26T14:02:27.000000Z'
                  created_by: 1302
                  deleted: false
                properties:
                  id:
                    type: string
                    example: bfefec7e-5ba6-4287-ac4a-753357584f16
                  object:
                    type: string
                    example: comment
                  parent_id:
                    type: string
                    example: null
                  text:
                    type: string
                    example: eaque
                  created_at:
                    type: string
                    example: '2020-11-26T14:02:27.000000Z'
                  created_by:
                    type: integer
                    example: 1302
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Comments
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'The body of the comment'
                  example: eaque
                parent_id:
                  type: parent
                  description: 'comment id'
                  example: null
    delete:
      summary: 'Delete comment'
      operationId: deleteComment
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: bfefec7e-5ba6-4287-ac4a-753357584f16
                  object: comment
                  deleted: true
                properties:
                  id:
                    type: string
                    example: bfefec7e-5ba6-4287-ac4a-753357584f16
                  object:
                    type: string
                    example: comment
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Comments
    parameters:
      -
        in: path
        name: comment
        description: 'Comment ID'
        example: bfefec7e-5ba6-4287-ac4a-753357584f16
        required: true
        schema:
          type: string
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
      -
        in: path
        name: item
        description: 'Item ID'
        example: 315a6847-26a7-4cf6-a66e-1a6b3c62a764
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/folders':
    get:
      summary: 'List folders'
      operationId: listFolders
      description: 'Lists all folders that belong to the board given.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: WG1XS3dZTWZOeFEsMjAyMC0xMS0yNiAxMzo1NzoxMQ==
                  after: OEZqWm9mejg5UE0sMjAyMC0xMS0yNiAxMzo1NzoxMQ==
                  data:
                    -
                      id: XmWKwYMfNxQ
                      object: folder
                      name: 'What to See in Barcelona'
                      sort_order: '589824.000000000000000000000000000000'
                      color: null
                      settings: []
                      attribute_ids:
                        - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                        - 012fc63b-b690-4db1-98a1-2f018f8941ce
                        - d2be0368-c5cd-43da-ae32-20a41304e9b1
                        - 5d4ec2cf-627e-4e35-b49f-c73e1fd85c47
                        - 8c78f989-5189-4b8c-b97f-96453007dc15
                        - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                      parent_id: LA1dW8i1TTK
                      deleted: false
                    -
                      id: APwqfkShQuR
                      object: folder
                      name: Preparation
                      sort_order: '524288.000000000000000000000000000000'
                      color: null
                      settings: []
                      attribute_ids:
                        - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                        - 3f723f19-5494-484b-a052-716d448c7629
                        - ab9ba009-da5d-4828-8c47-c53199f9b09b
                        - 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                        - 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                        - b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                      parent_id: LA1dW8i1TTK
                      deleted: false
                    -
                      id: 8FjZofz89PM
                      object: folder
                      name: 'Restaurants '
                      sort_order: '655360.000000000000000000000000000000'
                      color: null
                      settings: []
                      attribute_ids:
                        - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                        - 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                        - 9dfaf425-4b50-433d-b4d2-0c3a479c5119
                        - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                        - e3009b98-db05-4408-8414-c8ce5cd7c143
                      parent_id: LA1dW8i1TTK
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: WG1XS3dZTWZOeFEsMjAyMC0xMS0yNiAxMzo1NzoxMQ==
                  after:
                    type: string
                    example: OEZqWm9mejg5UE0sMjAyMC0xMS0yNiAxMzo1NzoxMQ==
                  data:
                    type: array
                    example:
                      -
                        id: XmWKwYMfNxQ
                        object: folder
                        name: 'What to See in Barcelona'
                        sort_order: '589824.000000000000000000000000000000'
                        color: null
                        settings: []
                        attribute_ids:
                          - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                          - 012fc63b-b690-4db1-98a1-2f018f8941ce
                          - d2be0368-c5cd-43da-ae32-20a41304e9b1
                          - 5d4ec2cf-627e-4e35-b49f-c73e1fd85c47
                          - 8c78f989-5189-4b8c-b97f-96453007dc15
                          - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                        parent_id: LA1dW8i1TTK
                        deleted: false
                      -
                        id: APwqfkShQuR
                        object: folder
                        name: Preparation
                        sort_order: '524288.000000000000000000000000000000'
                        color: null
                        settings: []
                        attribute_ids:
                          - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                          - 3f723f19-5494-484b-a052-716d448c7629
                          - ab9ba009-da5d-4828-8c47-c53199f9b09b
                          - 8712b2d2-7e59-41de-b8ee-7b00d08ca625
                          - 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                          - b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                        parent_id: LA1dW8i1TTK
                        deleted: false
                      -
                        id: 8FjZofz89PM
                        object: folder
                        name: 'Restaurants '
                        sort_order: '655360.000000000000000000000000000000'
                        color: null
                        settings: []
                        attribute_ids:
                          - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                          - 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                          - 9dfaf425-4b50-433d-b4d2-0c3a479c5119
                          - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                          - e3009b98-db05-4408-8414-c8ce5cd7c143
                        parent_id: LA1dW8i1TTK
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: XmWKwYMfNxQ
                        object:
                          type: string
                          example: folder
                        name:
                          type: string
                          example: 'What to See in Barcelona'
                        sort_order:
                          type: string
                          example: '589824.000000000000000000000000000000'
                        color:
                          type: string
                          example: null
                        settings:
                          type: array
                          example: []
                        attribute_ids:
                          type: array
                          example:
                            - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                            - 012fc63b-b690-4db1-98a1-2f018f8941ce
                            - d2be0368-c5cd-43da-ae32-20a41304e9b1
                            - 5d4ec2cf-627e-4e35-b49f-c73e1fd85c47
                            - 8c78f989-5189-4b8c-b97f-96453007dc15
                            - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                          items:
                            type: string
                        parent_id:
                          type: string
                          example: LA1dW8i1TTK
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Folders
    post:
      summary: 'Create folder'
      operationId: createFolder
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: RaZVJUpeGxY
                  object: folder
                  name: et
                  sort_order: 10
                  color: '#f57740'
                  settings: []
                  attribute_ids: []
                  parent_id: LA1dW8i1TTK
                  deleted: false
                properties:
                  id:
                    type: string
                    example: RaZVJUpeGxY
                  object:
                    type: string
                    example: folder
                  name:
                    type: string
                    example: et
                  sort_order:
                    type: integer
                    example: 10
                  color:
                    type: string
                    example: '#f57740'
                  settings:
                    type: array
                    example: []
                  attribute_ids:
                    type: array
                    example: []
                  parent_id:
                    type: string
                    example: LA1dW8i1TTK
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Folders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: ''
                  example: et
                color:
                  type: string
                  description: 'Folder color in the HEX format.'
                  example: '#f57740'
                parent_id:
                  type: string
                  description: 'If folder is sub-folder set parent_id otherwise it will be the top level folder.'
                  example: LA1dW8i1TTK
                attribute_ids:
                  type: object
                  description: 'An array of attribute IDs that are used in the folder.'
                  example: []
                  properties: []
                sort_order:
                  type: integer
                  description: ''
                  example: 10
                settings:
                  type: object
                  description: 'Meta data for the folder, it can contain many things.'
                  example: []
                  properties: []
              required:
                - name
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/folders/{folder}':
    get:
      summary: 'Get folder'
      operationId: getFolder
      description: 'Get folder by id that belong to the board given.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 8FjZofz89PM
                  object: folder
                  name: 'Restaurants '
                  sort_order: '655360.000000000000000000000000000000'
                  color: null
                  settings: []
                  attribute_ids:
                    - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                    - 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                    - 9dfaf425-4b50-433d-b4d2-0c3a479c5119
                    - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                    - e3009b98-db05-4408-8414-c8ce5cd7c143
                  parent_id: LA1dW8i1TTK
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 8FjZofz89PM
                  object:
                    type: string
                    example: folder
                  name:
                    type: string
                    example: 'Restaurants '
                  sort_order:
                    type: string
                    example: '655360.000000000000000000000000000000'
                  color:
                    type: string
                    example: null
                  settings:
                    type: array
                    example: []
                  attribute_ids:
                    type: array
                    example:
                      - e9eabdcd-66be-41d4-a88c-bdf8d05c28a9
                      - 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                      - 9dfaf425-4b50-433d-b4d2-0c3a479c5119
                      - 73ac1c73-a2f1-4542-b951-351b8cda4c87
                      - e3009b98-db05-4408-8414-c8ce5cd7c143
                    items:
                      type: string
                  parent_id:
                    type: string
                    example: LA1dW8i1TTK
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Folders
    put:
      summary: 'Update folder'
      operationId: updateFolder
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 8FjZofz89PM
                  object: folder
                  name: nemo
                  sort_order: '4.000000000000000000000000000000'
                  color: eum
                  settings: []
                  attribute_ids:
                    - e3009b98-db05-4408-8414-c8ce5cd7c143
                    - ab9ba009-da5d-4828-8c47-c53199f9b09b
                  parent_id: LA1dW8i1TTK
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 8FjZofz89PM
                  object:
                    type: string
                    example: folder
                  name:
                    type: string
                    example: nemo
                  sort_order:
                    type: string
                    example: '4.000000000000000000000000000000'
                  color:
                    type: string
                    example: eum
                  settings:
                    type: array
                    example: []
                  attribute_ids:
                    type: array
                    example:
                      - e3009b98-db05-4408-8414-c8ce5cd7c143
                      - ab9ba009-da5d-4828-8c47-c53199f9b09b
                    items:
                      type: string
                  parent_id:
                    type: string
                    example: LA1dW8i1TTK
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Folders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: ''
                  example: nemo
                color:
                  type: string
                  description: 'Folder color in the HEX format.'
                  example: eum
                parent_id:
                  type: string
                  description: ''
                  example: LA1dW8i1TTK
                attribute_ids:
                  type: array
                  description: 'An array of attribute IDs that are used in the folder.'
                  example:
                    - e3009b98-db05-4408-8414-c8ce5cd7c143
                    - ab9ba009-da5d-4828-8c47-c53199f9b09b
                  items:
                    type: string
                sort_order:
                  type: integer
                  description: ''
                  example: 4
              required:
                - name
    delete:
      summary: 'Delete folder'
      operationId: deleteFolder
      description: 'Deletes a folder by its id.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 8FjZofz89PM
                  object: folder
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 8FjZofz89PM
                  object:
                    type: string
                    example: folder
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Folders
    parameters:
      -
        in: path
        name: folder
        description: 'Folder ID'
        example: 8FjZofz89PM
        required: true
        schema:
          type: string
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/attachments/file':
    post:
      summary: 'Create attachment from file'
      operationId: createAttachmentFromFile
      description: "Upload files by submitting a file content as a `multipart/form-data`.\n\n ```javascript\n // Example: How to upload file with JavaScript\n const form = new FormData();\n form.append('file', document.getElementById('file-input'));\n axios.post('/api/v2/workspace/669/attachments/file', form);\n ```"
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 86245
                  link: 'https://app.startinfinity.com/storage/item-files/669/K7ZKZC19YED3Tfjj06RJ58dDH260hI88WGe5SSyk.jpg'
                  path: item-files/669/K7ZKZC19YED3Tfjj06RJ58dDH260hI88WGe5SSyk.jpg
                  original_name: test.jpg
                  filesize: 0
                  thumb: null
                  created_at: '2024-05-28T13:10:07.000000Z'
                  updated_at: '2024-05-28T13:10:07.000000Z'
                  team_id: 669
                  deleted_at: null
                  checked_at: null
                  extension: jpg
                  basename: test.jpg
                  filename: test
                properties:
                  id:
                    type: integer
                    example: 86245
                  link:
                    type: string
                    example: 'https://app.startinfinity.com/storage/item-files/669/K7ZKZC19YED3Tfjj06RJ58dDH260hI88WGe5SSyk.jpg'
                  path:
                    type: string
                    example: item-files/669/K7ZKZC19YED3Tfjj06RJ58dDH260hI88WGe5SSyk.jpg
                  original_name:
                    type: string
                    example: test.jpg
                  filesize:
                    type: integer
                    example: 0
                  thumb:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:07.000000Z'
                  updated_at:
                    type: string
                    example: '2024-05-28T13:10:07.000000Z'
                  team_id:
                    type: integer
                    example: 669
                  deleted_at:
                    type: string
                    example: null
                  checked_at:
                    type: string
                    example: null
                  extension:
                    type: string
                    example: jpg
                  basename:
                    type: string
                    example: test.jpg
                  filename:
                    type: string
                    example: test
      tags:
        - Attachments
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: 'File to upload'
              required:
                - file
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/attachments/url':
    post:
      summary: 'Create an attachment from URL'
      operationId: createAnAttachmentFromURL
      description: 'Download the attachment from a given URL, store it, and return an attachment object.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 86246
                  link: 'https://app.startinfinity.com/storage/item-files/669/5K4wLNduwemr6htcvIFzr7gvKnWi9CahqzK2RBeB.'
                  path: item-files/669/5K4wLNduwemr6htcvIFzr7gvKnWi9CahqzK2RBeB.
                  original_name: '300'
                  filesize: 6313
                  thumb: null
                  created_at: '2024-05-28T13:10:07.000000Z'
                  updated_at: '2024-05-28T13:10:07.000000Z'
                  team_id: 669
                  deleted_at: null
                  checked_at: null
                  extension: ''
                  basename: '300'
                  filename: '300'
                properties:
                  id:
                    type: integer
                    example: 86246
                  link:
                    type: string
                    example: 'https://app.startinfinity.com/storage/item-files/669/5K4wLNduwemr6htcvIFzr7gvKnWi9CahqzK2RBeB.'
                  path:
                    type: string
                    example: item-files/669/5K4wLNduwemr6htcvIFzr7gvKnWi9CahqzK2RBeB.
                  original_name:
                    type: string
                    example: '300'
                  filesize:
                    type: integer
                    example: 6313
                  thumb:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:07.000000Z'
                  updated_at:
                    type: string
                    example: '2024-05-28T13:10:07.000000Z'
                  team_id:
                    type: integer
                    example: 669
                  deleted_at:
                    type: string
                    example: null
                  checked_at:
                    type: string
                    example: null
                  extension:
                    type: string
                    example: ''
                  basename:
                    type: string
                    example: '300'
                  filename:
                    type: string
                    example: '300'
      tags:
        - Attachments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: 'Attachment URL.'
                  example: 'https://picsum.photos/seed/picsum/200/300'
              required:
                - url
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/views':
    get:
      summary: 'List Views'
      operationId: listViews
      description: 'List from the folder'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: query
          name: folder_id
          description: 'Views that belong to this folder.'
          example: 8FjZofz89PM
          required: false
          schema:
            type: string
            description: 'Views that belong to this folder.'
            example: 8FjZofz89PM
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: MTFjM2Q1NzUtODMwOS00Y2VmLTk1ZDMtMTdmMThhZGVhMWIzLA==
                  after: MTFjM2Q1NzUtODMwOS00Y2VmLTk1ZDMtMTdmMThhZGVhMWIzLA==
                  data:
                    -
                      id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                      object: folderview
                      folder_id: 8FjZofz89PM
                      name: 'Restaurant List'
                      type: list
                      sort_order: '65536.000000000000000000000000000000'
                      settings:
                        attributes: []
                        includeSubfolders: false
                        collapsedGroups: []
                        filter:
                          conditions: []
                          combinator: AND
                        sort:
                          conditions:
                            -
                              attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                              settings:
                                direction: asc
                      created_by: 1299
                      created_at: null
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: MTFjM2Q1NzUtODMwOS00Y2VmLTk1ZDMtMTdmMThhZGVhMWIzLA==
                  after:
                    type: string
                    example: MTFjM2Q1NzUtODMwOS00Y2VmLTk1ZDMtMTdmMThhZGVhMWIzLA==
                  data:
                    type: array
                    example:
                      -
                        id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                        object: folderview
                        folder_id: 8FjZofz89PM
                        name: 'Restaurant List'
                        type: list
                        sort_order: '65536.000000000000000000000000000000'
                        settings:
                          attributes: []
                          includeSubfolders: false
                          collapsedGroups: []
                          filter:
                            conditions: []
                            combinator: AND
                          sort:
                            conditions:
                              -
                                attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                                settings:
                                  direction: asc
                        created_by: 1299
                        created_at: null
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 11c3d575-8309-4cef-95d3-17f18adea1b3
                        object:
                          type: string
                          example: folderview
                        folder_id:
                          type: string
                          example: 8FjZofz89PM
                        name:
                          type: string
                          example: 'Restaurant List'
                        type:
                          type: string
                          example: list
                        sort_order:
                          type: string
                          example: '65536.000000000000000000000000000000'
                        settings:
                          type: object
                          properties:
                            attributes:
                              type: array
                              example: []
                            includeSubfolders:
                              type: boolean
                              example: false
                            collapsedGroups:
                              type: array
                              example: []
                            filter:
                              type: object
                              properties:
                                conditions:
                                  type: array
                                  example: []
                                combinator:
                                  type: string
                                  example: AND
                            sort:
                              type: object
                              properties:
                                conditions:
                                  type: array
                                  example:
                                    -
                                      attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                                      settings: { direction: asc }
                                  items:
                                    type: object
                                    properties:
                                      attributeId: { type: string, example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c }
                                      settings: { type: object, properties: { direction: { type: string, example: asc } } }
                        created_by:
                          type: integer
                          example: 1299
                        created_at:
                          type: string
                          example: null
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Views
    post:
      summary: 'Create view'
      operationId: createView
      description: 'Create a view'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: CGswYCQTe1X
                  object: folderview
                  folder_id: 8FjZofz89PM
                  name: 'List of Tasks'
                  type: list
                  sort_order: null
                  settings: []
                  created_by: 1302
                  created_at: '2024-05-28T13:10:07.000000Z'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: CGswYCQTe1X
                  object:
                    type: string
                    example: folderview
                  folder_id:
                    type: string
                    example: 8FjZofz89PM
                  name:
                    type: string
                    example: 'List of Tasks'
                  type:
                    type: string
                    example: list
                  sort_order:
                    type: string
                    example: null
                  settings:
                    type: array
                    example: []
                  created_by:
                    type: integer
                    example: 1302
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:07.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Views
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: ''
                  example: 'List of Tasks'
                folder_id:
                  type: string
                  description: ''
                  example: 8FjZofz89PM
                type:
                  type: string
                  description: ''
                  example: list
              required:
                - name
                - folder_id
                - type
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/views/{view}':
    get:
      summary: 'Get views'
      operationId: getViews
      description: 'Get views by id that belong to the folder given.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object: folderview
                  folder_id: 8FjZofz89PM
                  name: 'Restaurant List'
                  type: list
                  sort_order: '65536.000000000000000000000000000000'
                  settings:
                    attributes: []
                    includeSubfolders: false
                    collapsedGroups: []
                    filter:
                      conditions: []
                      combinator: AND
                    sort:
                      conditions:
                        -
                          attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                          settings:
                            direction: asc
                  created_by: 1299
                  created_at: null
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object:
                    type: string
                    example: folderview
                  folder_id:
                    type: string
                    example: 8FjZofz89PM
                  name:
                    type: string
                    example: 'Restaurant List'
                  type:
                    type: string
                    example: list
                  sort_order:
                    type: string
                    example: '65536.000000000000000000000000000000'
                  settings:
                    type: object
                    properties:
                      attributes:
                        type: array
                        example: []
                      includeSubfolders:
                        type: boolean
                        example: false
                      collapsedGroups:
                        type: array
                        example: []
                      filter:
                        type: object
                        properties:
                          conditions:
                            type: array
                            example: []
                          combinator:
                            type: string
                            example: AND
                      sort:
                        type: object
                        properties:
                          conditions:
                            type: array
                            example:
                              -
                                attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                                settings:
                                  direction: asc
                            items:
                              type: object
                              properties:
                                attributeId:
                                  type: string
                                  example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                                settings:
                                  type: object
                                  properties:
                                    direction:
                                      type: string
                                      example: asc
                  created_by:
                    type: integer
                    example: 1299
                  created_at:
                    type: string
                    example: null
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Views
    put:
      summary: 'Update view'
      operationId: updateView
      description: 'Get views by id that belong to the folder given.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object: folderview
                  folder_id: 8FjZofz89PM
                  name: 'Restaurant List'
                  type: list
                  sort_order: '65536.000000000000000000000000000000'
                  settings:
                    attributes: []
                    includeSubfolders: false
                    collapsedGroups: []
                    filter:
                      conditions: []
                      combinator: AND
                    sort:
                      conditions:
                        -
                          attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                          settings:
                            direction: asc
                  created_by: 1299
                  created_at: null
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object:
                    type: string
                    example: folderview
                  folder_id:
                    type: string
                    example: 8FjZofz89PM
                  name:
                    type: string
                    example: 'Restaurant List'
                  type:
                    type: string
                    example: list
                  sort_order:
                    type: string
                    example: '65536.000000000000000000000000000000'
                  settings:
                    type: object
                    properties:
                      attributes:
                        type: array
                        example: []
                      includeSubfolders:
                        type: boolean
                        example: false
                      collapsedGroups:
                        type: array
                        example: []
                      filter:
                        type: object
                        properties:
                          conditions:
                            type: array
                            example: []
                          combinator:
                            type: string
                            example: AND
                      sort:
                        type: object
                        properties:
                          conditions:
                            type: array
                            example:
                              -
                                attributeId: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                                settings:
                                  direction: asc
                            items:
                              type: object
                              properties:
                                attributeId:
                                  type: string
                                  example: 46b171c5-32fa-4bd8-b23a-f2bf4645632c
                                settings:
                                  type: object
                                  properties:
                                    direction:
                                      type: string
                                      example: asc
                  created_by:
                    type: integer
                    example: 1299
                  created_at:
                    type: string
                    example: null
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Views
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: ''
                  example: list
              required:
                - type
    delete:
      summary: 'Delete view'
      operationId: deleteView
      description: 'Delete the view'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object: folderview
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object:
                    type: string
                    example: folderview
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Views
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
      -
        in: path
        name: view
        description: 'Folder View ID'
        example: 11c3d575-8309-4cef-95d3-17f18adea1b3
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/members/invite':
    post:
      summary: 'Invite Member'
      operationId: inviteMember
      description: 'Invite the user into the workspace.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 1300
                  object: user
                  name: 'Jane Doe'
                  email: user@example.com
                  photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Jane%20Doe'
                  job: null
                  location: null
                  tagline: null
                  created_at: '2021-05-17T14:12:10.000000Z'
                  deleted: false
                properties:
                  id:
                    type: integer
                    example: 1300
                  object:
                    type: string
                    example: user
                  name:
                    type: string
                    example: 'Jane Doe'
                  email:
                    type: string
                    example: user@example.com
                  photo_url:
                    type: string
                    example: 'https://app.startinfinity.com/profile/avatar.svg?name=Jane%20Doe'
                  job:
                    type: string
                    example: null
                  location:
                    type: string
                    example: null
                  tagline:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2021-05-17T14:12:10.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: 'Email of the user that will be invited to the workspace.'
                  example: user@example.com
                role:
                  type: string
                  description: "Role that will user have in the workspace. Possible values: 'restricted-member', 'full-member', 'admin. default: restricted-member"
                  example: full-member
              required:
                - email
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/members/{user}':
    put:
      summary: 'Add Member'
      operationId: addMember
      description: 'Add a member to the workspace'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 1300
                  object: user
                  name: 'Jane Doe'
                  email: user@example.com
                  photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Jane%20Doe'
                  job: null
                  location: null
                  tagline: null
                  created_at: '2021-05-17T14:12:10.000000Z'
                  deleted: false
                properties:
                  id:
                    type: integer
                    example: 1300
                  object:
                    type: string
                    example: user
                  name:
                    type: string
                    example: 'Jane Doe'
                  email:
                    type: string
                    example: user@example.com
                  photo_url:
                    type: string
                    example: 'https://app.startinfinity.com/profile/avatar.svg?name=Jane%20Doe'
                  job:
                    type: string
                    example: null
                  location:
                    type: string
                    example: null
                  tagline:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2021-05-17T14:12:10.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Members
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                role:
                  type: string
                  description: "Role that will user have in the workspace. Possible values: 'restricted-member', 'full-member', 'admin. default: restricted-member"
                  example: full-member
    delete:
      summary: 'Remove Member'
      operationId: removeMember
      description: 'Remove member from the workspace'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 1300
                  object: user
                  name: 'Jane Doe'
                  email: user@example.com
                  photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Jane%20Doe'
                  job: null
                  location: null
                  tagline: null
                  created_at: '2021-05-17T14:12:10.000000Z'
                  deleted: false
                properties:
                  id:
                    type: integer
                    example: 1300
                  object:
                    type: string
                    example: user
                  name:
                    type: string
                    example: 'Jane Doe'
                  email:
                    type: string
                    example: user@example.com
                  photo_url:
                    type: string
                    example: 'https://app.startinfinity.com/profile/avatar.svg?name=Jane%20Doe'
                  job:
                    type: string
                    example: null
                  location:
                    type: string
                    example: null
                  tagline:
                    type: string
                    example: null
                  created_at:
                    type: string
                    example: '2021-05-17T14:12:10.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Members
    parameters:
      -
        in: path
        name: user
        description: 'Id of the existing user that should be added to the workspace.'
        example: 1300
        required: true
        schema:
          type: integer
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/users':
    get:
      summary: 'List users'
      operationId: listUsers
      description: 'Lists all users that belong to the current workspace given.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  after: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  data:
                    -
                      id: 1302
                      object: user
                      name: 'Damian Peterson'
                      email: damianpeterson@startinfinity.com
                      photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                      job: null
                      location: null
                      tagline: null
                      created_at: '2020-11-25T15:31:38.000000Z'
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  after:
                    type: string
                    example: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  data:
                    type: array
                    example:
                      -
                        id: 1302
                        object: user
                        name: 'Damian Peterson'
                        email: damianpeterson@startinfinity.com
                        photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                        job: null
                        location: null
                        tagline: null
                        created_at: '2020-11-25T15:31:38.000000Z'
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1302
                        object:
                          type: string
                          example: user
                        name:
                          type: string
                          example: 'Damian Peterson'
                        email:
                          type: string
                          example: damianpeterson@startinfinity.com
                        photo_url:
                          type: string
                          example: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                        job:
                          type: string
                          example: null
                        location:
                          type: string
                          example: null
                        tagline:
                          type: string
                          example: null
                        created_at:
                          type: string
                          example: '2020-11-25T15:31:38.000000Z'
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Users
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/members':
    get:
      summary: 'List users'
      operationId: listUsers
      description: 'Lists all users that belong to the current workspace given.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  after: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  data:
                    -
                      id: 1302
                      object: user
                      name: 'Damian Peterson'
                      email: damianpeterson@startinfinity.com
                      photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                      job: null
                      location: null
                      tagline: null
                      created_at: '2020-11-25T15:31:38.000000Z'
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  after:
                    type: string
                    example: MTMwMiwyMDIwLTExLTI1IDE1OjMxOjM4
                  data:
                    type: array
                    example:
                      -
                        id: 1302
                        object: user
                        name: 'Damian Peterson'
                        email: damianpeterson@startinfinity.com
                        photo_url: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                        job: null
                        location: null
                        tagline: null
                        created_at: '2020-11-25T15:31:38.000000Z'
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1302
                        object:
                          type: string
                          example: user
                        name:
                          type: string
                          example: 'Damian Peterson'
                        email:
                          type: string
                          example: damianpeterson@startinfinity.com
                        photo_url:
                          type: string
                          example: 'https://app.startinfinity.com/profile/avatar.svg?name=Damian%20Peterson'
                        job:
                          type: string
                          example: null
                        location:
                          type: string
                          example: null
                        tagline:
                          type: string
                          example: null
                        created_at:
                          type: string
                          example: '2020-11-25T15:31:38.000000Z'
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Users
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/references':
    get:
      summary: 'List references'
      operationId: listReferences
      description: 'Lists item references.'
      parameters:
        -
          in: query
          name: limit
          description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Limit of items between 1 and 100. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: sort_by
          description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
          example: created_at
          required: false
          schema:
            type: string
            description: 'Sort items by id or created date - default is created_at. Must be one of <code>id</code> or <code>created_at</code>.'
            example: created_at
        -
          in: query
          name: sort_direction
          description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction `asc` or `desc` - default is desc. Example: desc. Must be one of <code>asc</code> or <code>desc</code>.'
            example: desc
        -
          in: query
          name: after
          description: 'Use this parameter to get items after last item. Use this to get to the next page.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items after last item. Use this to get to the next page.'
            example: null
        -
          in: query
          name: before
          description: 'Use this parameter to get items before first item.'
          example: null
          required: false
          schema:
            type: string
            description: 'Use this parameter to get items before first item.'
            example: null
        -
          in: query
          name: from_item_id
          description: 'Filter items by source item id'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter items by source item id'
            example: null
        -
          in: query
          name: to_item_id
          description: 'Filter items by source item id'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter items by source item id'
            example: null
        -
          in: query
          name: attribute_id
          description: 'Filter items by source item id'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter items by source item id'
            example: null
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: ''
                  after: ''
                  data: []
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: ''
                  after:
                    type: string
                    example: ''
                  data:
                    type: array
                    example: []
      tags:
        - References
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                from_item_id:
                  type: string
                  description: ''
                  example: delectus
                to_item_id:
                  type: string
                  description: ''
                  example: sit
    post:
      summary: 'Create reference'
      operationId: createReference
      description: 'Creates a reference between two items.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 018fbf52-87a7-7113-bc3b-cb2c63512107
                  object: reference
                  attribute_id: b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                  from_item_id: 341a89c9-618e-40ba-92e1-1e12c83b69a6
                  to_item_id: 033709ef-aa01-4eb8-b4d0-5733e283c160
                properties:
                  id:
                    type: string
                    example: 018fbf52-87a7-7113-bc3b-cb2c63512107
                  object:
                    type: string
                    example: reference
                  attribute_id:
                    type: string
                    example: b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                  from_item_id:
                    type: string
                    example: 341a89c9-618e-40ba-92e1-1e12c83b69a6
                  to_item_id:
                    type: string
                    example: 033709ef-aa01-4eb8-b4d0-5733e283c160
      tags:
        - References
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                attribute_id:
                  type: string
                  description: ''
                  example: b5e95ec8-80bc-4a55-a996-dcea663e4e6c
                from_item_id:
                  type: string
                  description: ''
                  example: 341a89c9-618e-40ba-92e1-1e12c83b69a6
                to_item_id:
                  type: string
                  description: ''
                  example: 033709ef-aa01-4eb8-b4d0-5733e283c160
              required:
                - attribute_id
                - from_item_id
                - to_item_id
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/references/{reference}':
    get:
      summary: 'Get reference'
      operationId: getReference
      description: 'Get reference by its id for the given board.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object: reference
                  attribute_id: null
                  from_item_id: null
                  to_item_id: null
                properties:
                  id:
                    type: string
                    example: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object:
                    type: string
                    example: reference
                  attribute_id:
                    type: string
                    example: null
                  from_item_id:
                    type: string
                    example: null
                  to_item_id:
                    type: string
                    example: null
      tags:
        - References
    delete:
      summary: 'Delete reference'
      operationId: deleteReference
      description: 'Delete a reference between two items.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object: reference
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 11c3d575-8309-4cef-95d3-17f18adea1b3
                  object:
                    type: string
                    example: reference
                  deleted:
                    type: boolean
                    example: true
      tags:
        - References
    parameters:
      -
        in: path
        name: reference
        description: 'Optional parameter. The id of the folder view.'
        required: true
        schema:
          type: string
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 11c3d575-8309-4cef-95d3-17f18adea1b3
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/hooks':
    post:
      summary: 'Create hook'
      operationId: createHook
      description: 'Creates a new hook.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 018fbf52-87eb-72ca-97ac-69839bb74c46
                  object: hook
                  url: 'https://example.com/webhook/comment-created'
                  user_id: 1302
                  board_id: LA1dW8i1TTK
                  secret: mUdvlHILxXrkZpipA7tQiAl1gcCQQoWn
                  events:
                    -
                      event: comment.created
                      data: null
                  created_at: '2024-05-28T13:10:08.000000Z'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 018fbf52-87eb-72ca-97ac-69839bb74c46
                  object:
                    type: string
                    example: hook
                  url:
                    type: string
                    example: 'https://example.com/webhook/comment-created'
                  user_id:
                    type: integer
                    example: 1302
                  board_id:
                    type: string
                    example: LA1dW8i1TTK
                  secret:
                    type: string
                    example: mUdvlHILxXrkZpipA7tQiAl1gcCQQoWn
                  events:
                    type: array
                    example:
                      -
                        event: comment.created
                        data: null
                    items:
                      type: object
                      properties:
                        event:
                          type: string
                          example: comment.created
                        data:
                          type: string
                          example: null
                  created_at:
                    type: string
                    example: '2024-05-28T13:10:08.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Hooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: 'Must be a valid URL.'
                  example: 'https://example.com/webhook/comment-created'
                events:
                  type: array
                  description: ''
                  example:
                    -
                      event: comment.created
                  items:
                    type: string
              required:
                - url
                - events
    get:
      summary: 'List hooks'
      operationId: listHooks
      description: 'Lists the hooks of the currently logged in user.'
      parameters:
        -
          in: query
          name: expand
          description: "set to 'logs' to include hook logs in the response."
          example:
            - logs
          required: false
          schema:
            type: array
            description: "set to 'logs' to include hook logs in the response."
            example:
              - logs
            items:
              type: string
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  has_more: false
                  before: MjU1NTYxN2ItMDFlMi00NTAxLThhZDgtMmFlOGU0OTc2NmJm
                  after: NTY4NDBkMDUtMjJmMS00MmNiLTkyODgtYTZlZTAwNjc2MWY4
                  data:
                    -
                      id: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                      object: hook
                      url: 'http://domain.com/callback'
                      user_id: 1302
                      board_id: LA1dW8i1TTK
                      secret: D5DR6g203U6zB3X5nylgIGt45ZdbO1nO
                      logs: []
                      events: []
                      created_at: '2021-05-14T14:34:47.000000Z'
                      deleted: false
                    -
                      id: 56840d05-22f1-42cb-9288-a6ee006761f8
                      object: hook
                      url: 'http://domain.com/callback'
                      user_id: 1302
                      board_id: LA1dW8i1TTK
                      secret: XTTuLIBt70e4oSnNBzd1wx7QTJCXqEDD
                      logs: []
                      events: []
                      created_at: '2021-05-14T14:32:00.000000Z'
                      deleted: false
                properties:
                  has_more:
                    type: boolean
                    example: false
                  before:
                    type: string
                    example: MjU1NTYxN2ItMDFlMi00NTAxLThhZDgtMmFlOGU0OTc2NmJm
                  after:
                    type: string
                    example: NTY4NDBkMDUtMjJmMS00MmNiLTkyODgtYTZlZTAwNjc2MWY4
                  data:
                    type: array
                    example:
                      -
                        id: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                        object: hook
                        url: 'http://domain.com/callback'
                        user_id: 1302
                        board_id: LA1dW8i1TTK
                        secret: D5DR6g203U6zB3X5nylgIGt45ZdbO1nO
                        logs: []
                        events: []
                        created_at: '2021-05-14T14:34:47.000000Z'
                        deleted: false
                      -
                        id: 56840d05-22f1-42cb-9288-a6ee006761f8
                        object: hook
                        url: 'http://domain.com/callback'
                        user_id: 1302
                        board_id: LA1dW8i1TTK
                        secret: XTTuLIBt70e4oSnNBzd1wx7QTJCXqEDD
                        logs: []
                        events: []
                        created_at: '2021-05-14T14:32:00.000000Z'
                        deleted: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                        object:
                          type: string
                          example: hook
                        url:
                          type: string
                          example: 'http://domain.com/callback'
                        user_id:
                          type: integer
                          example: 1302
                        board_id:
                          type: string
                          example: LA1dW8i1TTK
                        secret:
                          type: string
                          example: D5DR6g203U6zB3X5nylgIGt45ZdbO1nO
                        logs:
                          type: array
                          example: []
                        events:
                          type: array
                          example: []
                        created_at:
                          type: string
                          example: '2021-05-14T14:34:47.000000Z'
                        deleted:
                          type: boolean
                          example: false
      tags:
        - Hooks
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
  '/api/v2/workspaces/{workspace}/boards/{board}/hooks/{hook}':
    put:
      summary: 'Update hook'
      operationId: updateHook
      description: 'Updates a hook.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                  object: hook
                  url: 'https://example.com/webhook/comment-created'
                  user_id: 1302
                  board_id: LA1dW8i1TTK
                  secret: D5DR6g203U6zB3X5nylgIGt45ZdbO1nO
                  events:
                    -
                      event: comment.created
                      data: null
                  created_at: '2021-05-14T14:34:47.000000Z'
                  deleted: false
                properties:
                  id:
                    type: string
                    example: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                  object:
                    type: string
                    example: hook
                  url:
                    type: string
                    example: 'https://example.com/webhook/comment-created'
                  user_id:
                    type: integer
                    example: 1302
                  board_id:
                    type: string
                    example: LA1dW8i1TTK
                  secret:
                    type: string
                    example: D5DR6g203U6zB3X5nylgIGt45ZdbO1nO
                  events:
                    type: array
                    example:
                      -
                        event: comment.created
                        data: null
                    items:
                      type: object
                      properties:
                        event:
                          type: string
                          example: comment.created
                        data:
                          type: string
                          example: null
                  created_at:
                    type: string
                    example: '2021-05-14T14:34:47.000000Z'
                  deleted:
                    type: boolean
                    example: false
      tags:
        - Hooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: 'Must be a valid URL.'
                  example: 'https://example.com/webhook/comment-created'
                events:
                  type: array
                  description: ''
                  example:
                    -
                      event: comment.created
                  items:
                    type: string
              required:
                - url
                - events
    delete:
      summary: 'Delete hook'
      operationId: deleteHook
      description: 'Deletes a hook that belongs to the currently logged in user.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                  object: hook
                  deleted: true
                properties:
                  id:
                    type: string
                    example: 2555617b-01e2-4501-8ad8-2ae8e49766bf
                  object:
                    type: string
                    example: hook
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Hooks
    parameters:
      -
        in: path
        name: workspace
        description: 'Workspace ID'
        example: '669'
        required: true
        schema:
          type: string
      -
        in: path
        name: board
        description: 'Board ID'
        example: LA1dW8i1TTK
        required: true
        schema:
          type: string
      -
        in: path
        name: hook
        description: 'Hook ID'
        example: 2555617b-01e2-4501-8ad8-2ae8e49766bf
        required: true
        schema:
          type: string
tags:
  -
    name: Profile
    description: ''
  -
    name: Workspaces
    description: ''
  -
    name: Boards
    description: ''
  -
    name: Attributes
    description: ''
  -
    name: Items
    description: ''
  -
    name: Comments
    description: ''
  -
    name: Folders
    description: ''
  -
    name: Attachments
    description: "\nThis endpoint is used as a first part of uploading file to the item. The response will contain\nthe attachment object, which can be used when creating a new item.\n```\n// When creating the item with attachments, value should have the following format:\n{\n  \"values\": [{\n    \"attribute_id\": \"a787da0a-7e17-48e5-bbf0-9142f19ed98f\",\n    \"data\": [{\"id\": \"<attachment_id>\"}]\n  }]\n}\n```\nUploaded attachments are not publicly accessible.\nThis means that when fetching items with attachments, links are publicly available for 2 hours and after that, they have to be re-fetched again."
  -
    name: Views
    description: "\nFolder views (tabs) is a configuration of how data will be presented in a given folder. It can contain view type (e.g. column or table), filters (what items to show) and many other settings that can be specific for the view (for example last viewed date in the calendar view)."
  -
    name: Members
    description: ''
  -
    name: Users
    description: ''
  -
    name: References
    description: ''
  -
    name: Hooks
    description: "\nThis type of webhooks are for programmatic usage, for example integrations. The webhook request contain two properties:\n`event`, which contains the name of the event (`value.updated`, `comment.created`, ...) and\n`payload` with entity data that is a subject of the event (check the code on the right side for example).\n\n<pre><code>\n// Example payload\n{\n  \"event\": \"value.created\",\n  \"payload\": {\n    \"id\": \"5455db29-d1a0-437e-8461-700d46ebadf7\",\n    \"object\": \"value\",\n    \"data\": \"Test\",\n    \"attribute_id\": \"a4b26453-156c-432f-8e13-bc6908cdc2de\",\n    \"deleted\": false\n  }\n}\n</code></pre>\n\nPay attention to the choice of the events that you want to react to because Infinity doesn't have a concept of *\"item created with all needed values filled\"*.\nAn item is created once and then additional values are created after that.\n\nThere are two ways to resolve this:\n1. If you need multiple attributes present on the item: listen for `value.created` event and, when it's triggered, fetch the item from the **items** endpoint and validate that all required attributes are present.\n\n2. If you need a single specific attribute to be present: listen for `value.created` event. This event is triggered the first time a value is added to the item. In the event handler check if the attribute_id of the created value matches the attribute that the user is interested in.\nCheck the example on the right side.\n\n<pre><code>\nfunction valueCreatedHandler(event) {\n  if (event.payload.attribute_id === '&ltid_of_label_attribute&gt') {\n    // Trigger\n  }\n}\n</code></pre>\n\nHooks are deactivated automatically after they fail to receive a response from the server after 3 attempts. The second attempt is triggered 1 minute after the first, and the next is 10 minutes after that."
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: ''
security:
  -
    default: []
