Endpoints
- POSTCreate Project
- GETList Projects
- GETGet Project
- PUTUpdate Project
- DELDelete Project
- POSTInvite a New User
- POSTAssign User
- GETList Users
- GETGet User
- PUTUpdate User
- DELUnassign User
- POSTCreate Metadata Schema
- GETList Metadata Schemas
- GETGet Metadata Schema
- PUTUpdate Metadata Schema
- DELDelete Metadata Schema
- POSTCreate Custom Event Schema
- GETList Custom Event Schemas
- GETGet Custom Event Schema
- PUTUpdate Custom Event Schema
- DELDelete Custom Event Schema
- POSTCreate Stacking Rules
- GETList Stacking Rules
- GETGet Stacking Rules
- PUTUpdate Stacking Rules
- DELDelete Stacking Rules
- POSTCreate Webhook
- GETList Webhooks
- GETGet Webhook
- PUTUpdate Webhook
- DELDelete Webhook
- POSTCreate Brand
- GETList Brands
- GETGet Brand
- PUTUpdate Brand
- DELDelete Brand
- GETList Campaign Templates
- POSTCopy Campaign Template to a Project
- POST
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
}List Projects
Lists all projects for the organization.
The endpoint does not require any query parameters.
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
}Response
Returns the list of all projects with their details.
Schema model for GET managment/v1/projects.
The type of the object represented by JSON. This object stores information about the projects in a dictionary.
list Identifies the name of the attribute that contains the array of project objects.
data Array of project objects.
Show child attributes
Show child attributes
Unique identifier of the project.
The name of the project.
A user-defined description of the project, e.g. its purpose, scope, region.
The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database.
The currency used in the project. It is equal to a 3-letter ISO 4217 code.
The webhook version used in the project.
v2024-01-01 An array of URL addresses that allow client requests.
Enables client-side redemption.
Enables client-side publication.
Enables client-side listing of vouchers.
Enables client-side creation of customers.
Enables client-side events for loyalty and referral programs.
Enables client-side setting of voucher expiration date.
Determines the notification settings for webhook callouts configured in Distributions and Project settings.
Show child attributes
Show child attributes
Determines the notification settings for webhooks sent through Distributions.
Show child attributes
Show child attributes
Enables the notification through an email.
Enables the notification through an email.
An array of email addresses which will receive the notification.
Determines the notification settings for webhooks sent as set out in the Project settings.
Show child attributes
Show child attributes
Enables the notification through an email.
Enables the notification through an email.
An array of email addresses which will receive the notification.
Determines the notification settings.
Show child attributes
Show child attributes
Determines the notification settings for redemptions. The notification can be used as a warning that a limit will be reached soon.
Show child attributes
Show child attributes
Enables the notification.
The percent value of the limit which, when reached, triggers the notification.
10 <= x <= 90Enables the notification in the application.
An array of email addresses which will receive the notification.
Determines the notification settings for distributed messages according to the day and month limit. The notification can be used as a warning that a limit will be reached soon.
Show child attributes
Show child attributes
Enables the notification.
The percent value of the limit which, when reached, triggers the notification.
10 <= x <= 90Enables the notification in the application.
An array of email addresses which will receive the notification.
Determines the notification settings for API calls made for the hourly limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum once per hour.
Show child attributes
Show child attributes
Enables the notification.
The percent value of the limit which, when reached, triggers the notification.
10 <= x <= 90Enables the notification in the application.
An array of email addresses which will receive the notification.
Determines the notification settings for bulk API calls made for the hourly limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum once per hour.
Show child attributes
Show child attributes
Enables the notification.
The percent value of the limit which, when reached, triggers the notification.
10 <= x <= 90Enables the notification in the application.
An array of email addresses which will receive the notification.
Determines the notification settings for webhook calls made for the daily limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum four times a day.
Show child attributes
Show child attributes
Enables the notification.
The percent value of the limit which, when reached, triggers the notification.
10 <= x <= 90Enables the notification in the application.
An array of email addresses which will receive the notification.
Determines the notification settings for API calls made for the billing cycle limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum once per the billing cycle.
Show child attributes
Show child attributes
Enables the notification.
The percent value of the limit which, when reached, triggers the notification.
10 <= x <= 90Enables the notification in the application.
An array of email addresses which will receive the notification.
The identifier of the cluster where the project will be created.
Determines if the vouchers in the project will be:
- case sensitive - if
true,C0dE-cfVis not equal toc0de-cfv), - case insensitive - if
false,C0dE-cfVis equal toc0de-cfv.
The API version used in the project. Currently, the default and only value is v2018-08-01.
v2018-08-01 Determines if the project is a sandbox project.
Webhook token used for authentication.
The country dial code for the project. It is equal to an ITU country code.
Determines additional limits set on a given project, e.g. the Sandbox project. If no limits are returned, the limits set for the whole organization apply.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determines the maximum number of API calls per time set in "duration".
Determines the amount of time during which the calls up to the number specified in the value can be made. The duration is presented in the ISO 8601 format, e.g. PT1H means one hour.
Show child attributes
Show child attributes
Determines the maximum number of API calls per time set in "duration".
Determines the amount of time during which the calls up to the number specified in the value can be made. The duration is presented in the ISO 8601 format, e.g. PT1H means one hour.
The total number of projects.
Was this page helpful?