Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Project

List projects

Returns a collection of projects

get/api/v1/projects

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

key'search' | 'id' | 'name' | 'keyName' | 'description' | 'currency' | 'normalTaxRate' | 'reducedTaxRate' | 'storageProcess' | 'pickingProcess'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
field'id' | 'name' | 'keyName' | 'description' | 'currency' | 'normalTaxRate' | 'reducedTaxRate' | 'storageProcess' | 'pickingProcess'
dir'asc' | 'desc'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "17",
      "name": "Berlin Project",
      "keyName": "BER_PROJ_001",
      "description": "A project based in Berlin focusing on software development and integration.",
      "currency": "EUR",
      "normalTaxRate": 13.3,
      "reducedTaxRate": 13.3,
      "storageProcess": "order",
      "pickingProcess": "invoiceMail",
      "defaultCustomerPaymentMethod": {
        "id": "13",
        "type": "paypal",
        "designation": "Paypal"
      },
      "defaultSupplierPaymentMethod": {
        "id": "13",
        "type": "paypal",
        "designation": "Paypal"
      },
      "defaultShippingMethod": {
        "id": "10",
        "type": "Go",
        "designation": "GO!"
      },
      "freeFields": [
        {
          "id": "1",
          "value": "test"
        },
        {
          "id": "2",
          "value": "test1"
        },
        {
          "id": "3",
          "value": ""
        }
      ]
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}