Skip to main content
GET
/
management
/
v1
/
projects
List Projects
curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>'
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "proj_TrlkLiH4",
      "name": "Test-project-01",
      "currency": "EUR",
      "timezone": "UTC",
      "cluster_id": "dev",
      "api_version": "v2018-08-01",
      "case_sensitive_codes": true,
      "client_trusted_domains": [],
      "client_redeem_enabled": false,
      "client_publish_enabled": false,
      "client_list_vouchers_enabled": false,
      "client_create_customer_enabled": false,
      "client_loyalty_events_enabled": false,
      "client_set_voucher_expiration_date_enabled": false,
      "api_usage_notifications": {
        "messages": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "api_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "cycle_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "redemptions": {
          "value": 80,
          "emails": [],
          "in_app": false,
          "enabled": false
        },
        "webhook_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "bulk_api_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        }
      },
      "webhooks_callout_notifications": {
        "webhooks": {
          "email": true,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true
        },
        "distributions": {
          "email": true,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true
        }
      },
      "is_sandbox": false,
      "webhook_version": "v2024-01-01"
    },
    {
      "id": "proj_yTNl0NT6",
      "name": "Test-project-01",
      "currency": "EUR",
      "timezone": "UTC",
      "cluster_id": "dev",
      "api_version": "v2018-08-01",
      "case_sensitive_codes": true,
      "client_trusted_domains": [],
      "client_redeem_enabled": false,
      "client_publish_enabled": false,
      "client_list_vouchers_enabled": false,
      "client_create_customer_enabled": false,
      "client_loyalty_events_enabled": false,
      "client_set_voucher_expiration_date_enabled": false,
      "api_usage_notifications": {
        "messages": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "api_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "cycle_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "redemptions": {
          "value": 80,
          "emails": [],
          "in_app": false,
          "enabled": false
        },
        "webhook_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "bulk_api_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        }
      },
      "webhooks_callout_notifications": {
        "webhooks": {
          "email": true,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true
        },
        "distributions": {
          "email": true,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true
        }
      },
      "is_sandbox": false,
      "webhook_version": "v2024-01-01"
    },
    {
      "id": "sand_CvFGa2LX",
      "name": "Sandbox Project",
      "currency": "EUR",
      "timezone": "Europe/Vienna",
      "cluster_id": "eu1",
      "api_version": "v2018-08-01",
      "description": "",
      "case_sensitive_codes": true,
      "client_trusted_domains": [],
      "client_redeem_enabled": false,
      "client_publish_enabled": false,
      "client_list_vouchers_enabled": false,
      "client_create_customer_enabled": false,
      "client_loyalty_events_enabled": false,
      "client_set_voucher_expiration_date_enabled": false,
      "api_usage_notifications": {
        "messages": {
          "value": 80,
          "emails": [],
          "in_app": false,
          "enabled": false
        },
        "api_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "cycle_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "redemptions": {
          "value": 80,
          "emails": [],
          "in_app": false,
          "enabled": false
        },
        "webhook_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        },
        "bulk_api_calls": {
          "value": 80,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true,
          "enabled": true
        }
      },
      "webhooks_callout_notifications": {
        "webhooks": {
          "email": true,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true
        },
        "distributions": {
          "email": true,
          "emails": [
            "your-email@domain.com"
          ],
          "in_app": true
        }
      },
      "is_sandbox": true,
      "limits": {
        "api_calls": [
          {
            "value": 100,
            "duration": "PT1H"
          }
        ],
        "bulk_api_calls": [
          {
            "value": 1,
            "duration": "PT1H"
          }
        ]
      },
      "default_code_config": {
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
      },
      "webhook_version": "v2024-01-01"
    }
  ],
  "total": 2
}

Authorizations

​
X-Management-Id
string
header
required
​
X-Management-Token
string
header
required

Response

Returns the list of all projects with their details.

Schema model for GET managment/v1/projects.

​
object
enum<string>
default:list
required

The type of the object represented by JSON. This object stores information about the projects in a dictionary.

Available options:
list
​
data_ref
enum<string>
default:data
required

Identifies the name of the attribute that contains the array of project objects.

Available options:
data
​
data
Management Project · object[]
required

Array of project objects.

​
total
integer
required

The total number of projects.

⌘I