Project settings and access tools

list_project_variables: List the project-level template variables.
get_consent_settings: Get the project's consent configuration.
list_project_users: List users with access to a project.
list_api_triggers: List the API trigger definitions in a project.
get_api_trigger: Get the full definition of an API trigger.

list_project_variables

Lists every project-level variable. Project variables are global key-value pairs that you can reference as {{ project_variable.reference }} substitutions inside Jinja templates across all campaigns — for example, brand name, support email, or base URL.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns a ProjectVariablesResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[ProjectVariable]`	The project-level variable definitions.
`error`	`str \| null`	Error message if the request failed.

The ProjectVariable object has the following fields:

Field	Type	Description
`reference`	`str`	The reference key. Use it as `{{ project_variable.reference }}` in Jinja templates.
`value`	`any \| null`	The current value of the variable.
`type`	`str \| null`	The data type — string, number, boolean, and so on.
`description`	`str \| null`	A human-readable description of what the variable represents.

get_consent_settings

Returns the project's consent configuration: GDPR mode, consent category definitions, and per-channel consent settings. Consent categories decide which campaigns a customer can receive based on their consent state.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns a ConsentSettingsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`any \| null`	The project's consent configuration: GDPR mode, consent categories, and per-channel consent settings. The exact shape depends on the project.
`error`	`str \| null`	Error message if the request failed.

list_project_users

Lists every user with access to a project, including their email, name, username, and role in this project.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns a ProjectUsersResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[ProjectUser]`	The users with access to this project.
`error`	`str \| null`	Error message if the request failed.

The ProjectUser object has the following fields:

Field	Type	Description
`id`	`str`	The user's ID.
`email`	`str \| null`	The user's email address.
`username`	`str \| null`	The username.
`first_name`	`str \| null`	The user's first name.
`last_name`	`str \| null`	The user's last name.
`role`	`str \| null`	The user's role in this project, for example `admin`, `editor`, or `viewer`.

list_api_triggers

Lists every API trigger definition in a project. API triggers let external systems fire a custom event into the Engagement platform with an HTTP call, which can then enter customers into scenarios. The response gives you the name, tags, archived flag, and metadata. The payload schema and linked scenarios are not included here — use get_api_trigger for those.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns an ApiTriggersResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[ApiTriggerSummary]`	The API trigger summaries.
`error`	`str \| null`	Error message if the request failed.

The ApiTriggerSummary object has the following fields:

Field	Type	Description
`id`	`str`	The API trigger's unique ID.
`name`	`str`	The trigger's display name.
`archived`	`bool`	Whether the trigger has been archived.
`tags`	`list[str]`	User-defined tags.
`created`	`any \| null`	Unix timestamp of when the trigger was created.
`created_by_display_name`	`str \| null`	Display name of the creator.
`edited`	`any \| null`	Unix timestamp of the last edit.
`edited_by_display_name`	`str \| null`	Display name of the last editor.

get_api_trigger

Returns the full definition of a single API trigger, including the event type it fires, the payload property schema, and the scenarios that listen to it.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`trigger_id`	`str`	Yes	The API trigger ID returned by `list_api_triggers`.

Response parameters

The tool returns an ApiTriggerResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`ApiTrigger \| null`	The full API trigger definition.
`error`	`str \| null`	Error message if the request failed.

The ApiTrigger object adds the following fields on top of the summary record:

Field	Type	Description
`event_type`	`str \| null`	The event type the trigger fires when it is called.
`properties`	`list[any]`	The property definitions for the trigger payload: name, type, and required flag.
`scenario_ids`	`list[str]`	IDs of the scenarios that use this API trigger as their entry point.