--- title: "Get Project" method: GET path: "/management/v1/projects/{projectId}" tags: ["Management"] --- # Get Project `GET /management/v1/projects/{projectId}` Retrieves an existing project. ## Response `200` Returns the details of a project. - ManagementProjectsGetResponseBody — Object representing a project. - `id` string, required — Unique identifier of the project. - `name` string, required — The name of the project. - `description` string, required — A user-defined description of the project, e.g. its purpose, scope, region. - `timezone` string, 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. - `currency` string, required — The currency used in the project. It is equal to a 3-letter ISO 4217 code. - `dial_code` string, 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_domains` string[], required — An array of URL addresses that allow client requests. - `client_redeem_enabled` boolean, required — Enables client-side redemption. - `client_publish_enabled` boolean, required — Enables client-side publication. - `client_list_vouchers_enabled` boolean, required — Enables client-side listing of vouchers. - `client_create_customer_enabled` boolean, required — Enables client-side creation of customers. - `client_loyalty_events_enabled` boolean, required — Enables client-side events for loyalty and referral programs. - `client_set_voucher_expiration_date_enabled` boolean, required — Enables client-side setting of voucher expiration date. - `webhooks_callout_notifications` object, required — Determines the notification settings for webhook callouts configured in Distributions and Project settings. - `distributions` object, required — Determines the notification settings for webhooks sent through Distributions. - `email` boolean, required — Enables the notification through an email. - `in_app` boolean, required — Enables the notification through an email. - `emails` string[], required — An array of email addresses which will receive the notification. - `webhooks` object, required — Determines the notification settings for webhooks sent as set out in the Project settings. - `email` boolean, required — Enables the notification through an email. - `in_app` boolean, required — Enables the notification through an email. - `emails` string[], required — An array of email addresses which will receive the notification. - `api_usage_notifications` object, required — Determines the notification settings. - `redemptions` UsageNotifications, required - `enabled` boolean, required — Enables the notification. - `value` integer, required — The percent value of the limit which, when reached, triggers the notification. - `in_app` boolean, required — Enables the notification in the application. - `emails` string[], required — An array of email addresses which will receive the notification. - `messages` UsageNotifications, required - `enabled` boolean, required — Enables the notification. - `value` integer, required — The percent value of the limit which, when reached, triggers the notification. - `in_app` boolean, required — Enables the notification in the application. - `emails` string[], required — An array of email addresses which will receive the notification. - `api_calls` UsageNotifications, required - `enabled` boolean, required — Enables the notification. - `value` integer, required — The percent value of the limit which, when reached, triggers the notification. - `in_app` boolean, required — Enables the notification in the application. - `emails` string[], required — An array of email addresses which will receive the notification. - `bulk_api_calls` UsageNotifications, required - `enabled` boolean, required — Enables the notification. - `value` integer, required — The percent value of the limit which, when reached, triggers the notification. - `in_app` boolean, required — Enables the notification in the application. - `emails` string[], required — An array of email addresses which will receive the notification. - `webhook_calls` UsageNotifications, required - `enabled` boolean, required — Enables the notification. - `value` integer, required — The percent value of the limit which, when reached, triggers the notification. - `in_app` boolean, required — Enables the notification in the application. - `emails` string[], required — An array of email addresses which will receive the notification. - `cycle_calls` UsageNotifications, required - `enabled` boolean, required — Enables the notification. - `value` integer, required — The percent value of the limit which, when reached, triggers the notification. - `in_app` boolean, required — Enables the notification in the application. - `emails` string[], required — An array of email addresses which will receive the notification. - `cluster_id` string, required — The identifier of the cluster where the project will be created. - `case_sensitive_codes` boolean, 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_sandbox` boolean, required — Determines if the project is a sandbox project. - `webhook_token` string, required — Webhook token used for authentication. - `default_code_config` object — Determines the character set that is used as default for vouchers. It is affected by the `"case_sensitive_codes"` setting. - `charset` string, required — Lists all characters that are used as default for vouchers - `limits` object — 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. - `api_calls` object[] - `value` integer — Determines the maximum number of API calls per time set in `"duration"`. - `duration` string — 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. - `bulk_api_calls` object[] - `value` integer — Determines the maximum number of API calls per time set in `"duration"`. - `duration` string — 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. ## Other responses - `402` — Returns an error if the current plan does not include the Management API feature. - `404` — Returns an error when a resource could not be found. --- [API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/versions/4982266e0494/schema)