> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# persona-cases
> Persona Cases - Cases, reports, and transactions
**Server path:** `/persona-cases` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [`persona_cases_add_persona_objects`](#persona_cases_add_persona_objects) | Add Persona objects to a Case |
| [`persona_cases_add_tag`](#persona_cases_add_tag) | Add tag to a Case |
| [`persona_cases_assign_a_case`](#persona_cases_assign_a_case) | Assign a Case |
| [`persona_cases_create_a_case`](#persona_cases_create_a_case) | Create a Case |
| [`persona_cases_create_a_report`](#persona_cases_create_a_report) | Create a Report |
| [`persona_cases_create_a_transaction`](#persona_cases_create_a_transaction) | Create a Transaction |
| [`persona_cases_create_a_transaction_label`](#persona_cases_create_a_transaction_label) | Create a Transaction label |
| [`persona_cases_dismiss_matches`](#persona_cases_dismiss_matches) | Report Action: Dismiss Matches |
| [`persona_cases_list_all_cases`](#persona_cases_list_all_cases) | List all Cases |
| [`persona_cases_list_all_reports`](#persona_cases_list_all_reports) | List all Reports |
| [`persona_cases_list_all_transactions`](#persona_cases_list_all_transactions) | List all Transactions |
| [`persona_cases_list_report_history`](#persona_cases_list_report_history) | List Report history |
| [`persona_cases_print_report_pdf`](#persona_cases_print_report_pdf) | Print Report PDF |
| [`persona_cases_redact_a_case`](#persona_cases_redact_a_case) | Redact a Case |
| [`persona_cases_redact_a_report`](#persona_cases_redact_a_report) | Redact a Report |
| [`persona_cases_redact_a_transaction`](#persona_cases_redact_a_transaction) | Redact a Transaction |
| [`persona_cases_redact_transaction_biometrics`](#persona_cases_redact_transaction_biometrics) | Redact Transaction biometrics |
| [`persona_cases_remove_tag`](#persona_cases_remove_tag) | Remove tag from a Case |
| [`persona_cases_report_action_pause_continuous_monitoring`](#persona_cases_report_action_pause_continuous_monitoring) | Report Action: Pause Continuous Monitoring |
| [`persona_cases_report_action_re_run_report`](#persona_cases_report_action_re_run_report) | Report Action: Re-run Report |
| [`persona_cases_report_action_resume_continuous_monitoring`](#persona_cases_report_action_resume_continuous_monitoring) | Report Action: Resume Continuous Monitoring |
| [`persona_cases_reports_add_tag`](#persona_cases_reports_add_tag) | Add tag to a Report |
| [`persona_cases_reports_remove_tag`](#persona_cases_reports_remove_tag) | Remove tag from a Report |
| [`persona_cases_reports_set_all_tags`](#persona_cases_reports_set_all_tags) | Set tags on a Report |
| [`persona_cases_retrieve_a_report`](#persona_cases_retrieve_a_report) | Retrieve a Report |
| [`persona_cases_retrieve_a_transaction`](#persona_cases_retrieve_a_transaction) | Retrieve a Transaction |
| [`persona_cases_retrieve_case`](#persona_cases_retrieve_case) | Retrieve a Case |
| [`persona_cases_search_cases`](#persona_cases_search_cases) | Search Cases |
| [`persona_cases_set_status_for_a_case`](#persona_cases_set_status_for_a_case) | Set status on a Case |
| [`persona_cases_set_tags`](#persona_cases_set_tags) | Set tags on a Case |
| [`persona_cases_transactions_add_tag`](#persona_cases_transactions_add_tag) | Add tag to Transaction |
| [`persona_cases_transactions_remove_tag`](#persona_cases_transactions_remove_tag) | Remove tag from a Transaction |
| [`persona_cases_transactions_set_tags`](#persona_cases_transactions_set_tags) | Sets tags on a Transaction |
| [`persona_cases_update_a_case`](#persona_cases_update_a_case) | Update a Case |
| [`persona_cases_update_a_transaction`](#persona_cases_update_a_transaction) | Update a Transaction |
***
## persona\_cases\_add\_persona\_objects
Add Persona objects to a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"object-ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of Persona object IDs to attach to this case. The following object types are supported- accounts, documents, graph queries, inquiries, reports, report runs, sars, transactions, and, verifications."
}
}
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_add\_tag
Add tag to a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to add to the Case."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to add to the Case."
}
}
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_assign\_a\_case
Assign a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update |
| `meta` | object | Yes | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"user-email-address": {
"type": "string",
"description": "Email address of the Persona user to whom to assign this case"
}
},
"required": [
"user-email-address"
]
}
},
"required": [
"PCID",
"case-id",
"meta"
]
}
```
***
## persona\_cases\_create\_a\_case
Create a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `data` | object | Yes | — | The data value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "Properties can include Case Template ID, creator email address, and fields configured on your Case Template."
}
}
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"object-ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of Persona object IDs that should be related to this case. The following object types are supported- accounts, documents, graph queries, inquiries, reports, report runs, sars, transactions, and, verifications."
},
"sla-expires-in-seconds": {
"type": "number",
"description": "Number of seconds from now when SLA expires (max of 90 days)."
}
}
}
},
"required": [
"PCID",
"data"
]
}
```
***
## persona\_cases\_create\_a\_report
Create a Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `data` | object | No | — | The data value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"data": {
"description": "The data value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"auto-create-account": {
"type": "boolean",
"description": "If true, automatically create an Account for the user if one does not exist. Default is true."
},
"auto-create-account-type-id": {
"type": "string",
"description": "If `auto-create-account` is true, the type ID to use for the Account. If not provided, the default type ID for the organization will be used."
},
"auto-create-account-reference-id": {
"type": "string",
"description": "If `auto-create-account` is true, this Report will be attached to the Account with this reference ID, or a new Account will be created with this reference ID if one does not exist."
},
"processing-mode": {
"type": "string",
"description": "The processing mode for the report."
},
"request-flags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The request-flags value"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_cases\_create\_a\_transaction
Create a Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `data` | object | No | — | The data value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
},
"meta": {
"type": "object",
"description": "The meta value"
}
},
"required": [
"PCID"
]
}
```
***
## persona\_cases\_create\_a\_transaction\_label
Create a Transaction label
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | ID of the transaction to create a label for. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "ID of the transaction to create a label for."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"label": {
"type": "string",
"description": "The label value"
},
"score": {
"type": "number",
"description": "The score value"
},
"model-version": {
"type": "string",
"description": "The model-version value"
}
}
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_dismiss\_matches
Report Action: Dismiss Matches
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID",
"report-id",
"data"
]
}
```
***
## persona\_cases\_list\_all\_cases
List all Cases
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `filter` | object | No | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"status": {
"type": "string",
"description": "Filter cases by status"
},
"case-template-id": {
"type": "string",
"description": "Filter cases by case template ID"
},
"account-id": {
"type": "string",
"description": "Filter cases by account ID"
},
"reference-id": {
"type": "string",
"description": "Filter cases by reference ID"
},
"inquiry-id": {
"type": "string",
"description": "Filter cases by inquiry ID"
},
"report-id": {
"type": "string",
"description": "Filter cases by report ID"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_cases\_list\_all\_reports
List all Reports
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `filter` | object | No | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"reference-id": {
"type": "string",
"description": "Filter reports by reference ID"
},
"account-id": {
"type": "string",
"description": "Filter reports by account ID"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_cases\_list\_all\_transactions
List all Transactions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `filter` | object | No | — | The filter value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"filter": {
"type": "object",
"description": "The filter value",
"properties": {
"reference-id": {
"type": "string",
"description": "Filter transactions by reference ID."
},
"transaction-type-id": {
"type": "string",
"description": "Filter transactions by Transaction Type ID."
},
"identifier": {
"type": "object",
"description": "Filter transactions by Identifier Key and Value"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## persona\_cases\_list\_report\_history
List Report history
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `page` | object | No | — | Page number for pagination |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"page": {
"type": "object",
"description": "Page number for pagination",
"properties": {
"after": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"before": {
"type": "string",
"description": "Object ID for pagination cursor"
},
"size": {
"type": "number",
"description": "Limit on the number of objects returned"
}
}
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_print\_report\_pdf
Print Report PDF
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_redact\_a\_case
Redact a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | The case-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "The case-id value"
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_redact\_a\_report
Redact a Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_redact\_a\_transaction
Redact a Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | The transaction-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "The transaction-id value"
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_redact\_transaction\_biometrics
Redact Transaction biometrics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | The transaction-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "The transaction-id value"
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_remove\_tag
Remove tag from a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to remove from the Case."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to add to the Case."
}
}
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_report\_action\_pause\_continuous\_monitoring
Report Action: Pause Continuous Monitoring
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_report\_action\_re\_run\_report
Report Action: Re-run Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_report\_action\_resume\_continuous\_monitoring
Report Action: Resume Continuous Monitoring
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_reports\_add\_tag
Add tag to a Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to add to the Report."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to add to the Report."
}
}
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_reports\_remove\_tag
Remove tag from a Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to remove from the Report."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to remove from the Report."
}
}
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_reports\_set\_all\_tags
Set tags on a Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tag-name value"
},
"tag-id": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tag-id value"
}
}
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_retrieve\_a\_report
Retrieve a Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `report-id` | string | Yes | — | The report-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"report-id": {
"type": "string",
"description": "The report-id value"
}
},
"required": [
"PCID",
"report-id"
]
}
```
***
## persona\_cases\_retrieve\_a\_transaction
Retrieve a Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | ID of the transaction to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "ID of the transaction to retrieve."
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_retrieve\_case
Retrieve a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | The case-id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "The case-id value"
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_search\_cases
Search Cases
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `page` | object | No | — | Pagination parameters |
| `query` | object | No | — | Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Pass as a JSON object with boolean logic (AND/OR/NOT) and comparison predicates. |
| `sort` | object | No | — | Sort configuration for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"page": {
"type": "object",
"description": "Pagination parameters",
"properties": {
"after": {
"type": "string",
"description": "Cursor for forward pagination"
},
"before": {
"type": "string",
"description": "Cursor for backward pagination"
},
"size": {
"type": "integer",
"description": "Number of results to return per page"
}
}
},
"query": {
"type": "object",
"description": "Search query using boolean logic (AND/OR/NOT) and comparison operators. Supports predicates with operators: eq (equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Pass as a JSON object with boolean logic (AND/OR/NOT) and comparison predicates."
},
"sort": {
"type": "object",
"description": "Sort configuration for results",
"properties": {
"attribute": {
"type": "string",
"description": "The attribute name to sort by"
},
"direction": {
"type": "string",
"description": "Sort direction. Possible values: asc (ascending), desc (descending)."
}
},
"required": [
"attribute",
"direction"
]
}
},
"required": [
"PCID"
]
}
```
***
## persona\_cases\_set\_status\_for\_a\_case
Set status on a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update status |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update status"
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"status": {
"type": "string",
"description": "Status to update case to"
}
},
"required": [
"status"
]
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_set\_tags
Set tags on a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Names of the tags to add to the Case."
},
"tag-id": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of the tags to add to the Case."
}
}
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_transactions\_add\_tag
Add tag to Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | ID of the transaction to add tag on. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "ID of the transaction to add tag on."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to add to the Transaction."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to add to the Transaction."
}
}
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_transactions\_remove\_tag
Remove tag from a Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | ID of the transaction to remove tag from. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "ID of the transaction to remove tag from."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "string",
"description": "Name of the tag to add to the Transaction."
},
"tag-id": {
"type": "string",
"description": "ID of the tag to add to the Transaction."
}
}
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_transactions\_set\_tags
Sets tags on a Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | ID of the transaction to set tags on. |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "ID of the transaction to set tags on."
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"tag-name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Name of the tag to add to the Transaction."
},
"tag-id": {
"type": "array",
"items": {
"type": "string"
},
"description": "ID of the tag to add to the Transaction."
}
}
}
},
"required": [
"PCID",
"transaction-id"
]
}
```
***
## persona\_cases\_update\_a\_case
Update a Case
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `case-id` | string | Yes | — | ID of the case to update |
| `data` | object | No | — | The data value |
| `meta` | object | No | — | The meta value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"case-id": {
"type": "string",
"description": "ID of the case to update"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
},
"meta": {
"type": "object",
"description": "The meta value",
"properties": {
"sla-expires-in-seconds": {
"type": "number",
"description": "Number of seconds from now when SLA expires (max of 90 days). Set to null to clear SLA."
}
}
}
},
"required": [
"PCID",
"case-id"
]
}
```
***
## persona\_cases\_update\_a\_transaction
Update a Transaction
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Key-Inflection` | string | No | — | Determines casing for the API response. |
| `Idempotency-Key` | string | No | — | Ensures the request is idempotent. |
| `Persona-Version` | string | No | — | Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). |
| `include` | string | No | — | A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. |
| `fields` | object | No | — | Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. |
| `transaction-id` | string | Yes | — | ID of the transaction to update. |
| `data` | object | No | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Key-Inflection": {
"type": "string",
"description": "Determines casing for the API response.",
"enum": [
"camel",
"kebab",
"snake"
]
},
"Idempotency-Key": {
"type": "string",
"description": "Ensures the request is idempotent."
},
"Persona-Version": {
"type": "string",
"description": "Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).",
"enum": [
"2025-12-08",
"2025-10-27",
"2023-01-05",
"2022-09-01",
"2021-08-18",
"2021-07-05",
"2021-02-21",
"2020-05-18"
]
},
"include": {
"type": "string",
"description": "A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details."
},
"fields": {
"type": "object",
"description": "Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details."
},
"transaction-id": {
"type": "string",
"description": "ID of the transaction to update."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"attributes": {
"type": "object",
"description": "The attributes value"
}
}
}
},
"required": [
"PCID",
"transaction-id"
]
}
```