Retrieve project settings

Reads the project's settings: how purchases reported by another account are shared, whether store sandbox purchases unlock production apps, and the conversion ad spend is measured against.

Guide: Teams, projects and environments

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Projects

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRemove a project's logo NextUpdate project settings

On this page

Authorization Path parameters Examples Response body Errors More in Projects

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/settings" \  -H "Authorization: Bearer vh_sk_..."

{  "paidAccessSharing": {    "production": "shared",    "sandbox": "shared"  },  "storeSandbox": {    "isUnlockingProduction": false  },  "ads": {    "keyConversion": "trial",    "attributionWindowDays": 7  }}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Retrieve project settings

Errors

More in Projects

Retrieve project settings

Errors

More in Projects

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Retrieve project settings

Retrieve project settings

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`