VOvoucherifyio
Management

Get Project

Retrieves an existing project.

get/management/v1/projects/{projectId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/management/v1/projects/{projectId}
  • Auth
    API key in header X-Management-Id and API key in header X-Management-Token

Response

Returns the details of a project.

idstring required

Unique identifier of the project.

namestring required

The name of the project.

descriptionstring required

A user-defined description of the project, e.g. its purpose, scope, region.

timezonestring required

The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database.

currencystring required

The currency used in the project. It is equal to a 3-letter ISO 4217 code.

dial_codestring nullable

The country dial code for the project. It is equal to an ITU country code.

webhook_version'v2024-01-01' required

The webhook version used in the project.

client_trusted_domainsstring[] required

An array of URL addresses that allow client requests.

client_redeem_enabledboolean required

Enables client-side redemption.

client_publish_enabledboolean required

Enables client-side publication.

client_list_vouchers_enabledboolean required

Enables client-side listing of vouchers.

client_create_customer_enabledboolean required

Enables client-side creation of customers.

client_loyalty_events_enabledboolean required

Enables client-side events for loyalty and referral programs.

client_set_voucher_expiration_date_enabledboolean required

Enables client-side setting of voucher expiration date.

cluster_idstring required

The identifier of the cluster where the project will be created.

case_sensitive_codesboolean required

Determines if the vouchers in the project will be:

  • case sensitive - if true, C0dE-cfV is not equal to c0de-cfv),
  • case insensitive - if false, C0dE-cfV is equal to c0de-cfv.
api_version'v2018-08-01' required

The API version used in the project. Currently, the default and only value is v2018-08-01.

is_sandboxboolean required

Determines if the project is a sandbox project.

webhook_tokenstring required

Webhook token used for authentication.

Changes

No recorded changes to this operation across all 1 revision of this API.