> For the complete documentation index, see [llms.txt](https://developer.prodege.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.prodege.com/demand/api-reference/project-calls/get-project-settings.md).

# Get Project Settings

| **Get Project Info** |                                                  |
| -------------------- | ------------------------------------------------ |
| Description          | Get detailed information of an existing project  |
| Request URL          | *Prodege Base URL +* /project-settings-get       |
| Request Method       | <mark style="background-color:green;">GET</mark> |

&#x20;

| Request Parameters   |                |                                                                                                            |           |
| -------------------- | -------------- | ---------------------------------------------------------------------------------------------------------- | --------- |
| Parameter Name       | Parameter Type | Description                                                                                                | Required? |
| apik                 | String         | Your API Key.                                                                                              | Yes       |
| request\_date        | Numeric        | Timestamp in milliseconds (see [Authentication](https://developer.prodege.com/demand/authentication)).     | Yes       |
| signature            | String         | The signature of your request (see [Authentication](https://developer.prodege.com/demand/authentication)). | Yes       |
| prodege\_project\_id | Numeric        | The ID that uniquely identifies the project in the Prodege system.                                         | Yes       |

&#x20;

| Response Parameters |                |                                                                                                       |
| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------- |
| Parameter Name      | Parameter Type | Description                                                                                           |
| *return\_status*    | String         | The return status for this api call (\*Currently only for failed requests)                            |
| *project\_settings* | String         | JSON string that holds the current settings for the project                                           |
| *projects*          | String         | JSON array that holds the current past participation inclusions or exclusions, if any are configured. |

*project\_settings Model*

| Property Name                             | Property Type | Description                                                                                                                              |
| ----------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| enable\_max\_clicks                       | Boolean       | Whether or not max click logic is enforced                                                                                               |
| enable\_max\_clicks\_cap                  | Numeric       | If max click logic is enforced, the user-specified number of clicks allowed before pausing project traffic                               |
| enable\_max\_clicks\_allowed\_clicks      | Numeric       | If max click logic is enforced, the current remaining number of clicks before pausing project traffic                                    |
| enable\_max\_clicks\_max\_click\_rate\_id | Numeric       | If max click logic is enforced, the refill rate id for clicks (1: every 30 min, 2: every 1 hour, 3: every 24 hours, 0: one-time setting) |
| enable\_quality\_screener                 | Boolean       | Whether or not quality screener is enforced                                                                                              |
| require\_rvid                             | Boolean       | Whether or not relevant id checking is enforced                                                                                          |
| *limit\_panelists*                        | JSON          | Panelist-specific filter settings                                                                                                        |

*projects Model*

| Property Name               | Property Type | Description                                                                                                                                                                                                                  |
| --------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| participation\_status       | Numeric       | The types of transactions for the included/excluded prodege\_project\_ids that are included in the inclusion/exclusion. Possible values are 1 for click, 2 for complete, 4 for DQ, 8 for OQ (bit values are added together). |
| surveys                     | Array         | The list of projects being included or excluded.                                                                                                                                                                             |
| participation\_filter\_type | Numeric       | The filter type, either inclusion or exclusion. 1 for inclusion or 2 for exclusion.                                                                                                                                          |
