persona-admin - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /persona-admin | Type: Application | PCID required: Yes

Tools

Tool	Description
`persona_admin_archive_a_webhook`	Archive a Webhook
`persona_admin_clone_a_webhook`	Clone a Webhook
`persona_admin_clone_api_key`	Clone an API key
`persona_admin_create_a_connect_connection`	Create a Connection
`persona_admin_create_a_graph_query`	Create a Graph Query
`persona_admin_create_a_share_token`	Create a Share Token
`persona_admin_create_a_webhook`	Create a Webhook
`persona_admin_create_a_workflow_run`	Create a Workflow Run
`persona_admin_create_an_api_key`	Create an API key
`persona_admin_deactivate_a_connect_connection`	Deactivate a Connect Connection
`persona_admin_disable_a_webhook`	Disable a Webhook
`persona_admin_enable_a_webhook`	Enable a Webhook
`persona_admin_expire_an_api_key`	Expire an API key
`persona_admin_expire_share_token`	Expire a Share Token
`persona_admin_import_an_account`	Import Accounts
`persona_admin_import_email_address_lists`	Import Email Address Lists
`persona_admin_import_geolocation_lists`	Import Geolocation Lists
`persona_admin_import_government_id_number_lists`	Import Government ID Number Lists
`persona_admin_import_ip_address_lists`	Import IP Address Lists
`persona_admin_import_name_lists`	Import Name Lists
`persona_admin_import_phone_number_lists`	Import Phone Number Lists
`persona_admin_list_all_api_keys`	List all API keys
`persona_admin_list_all_api_logs`	List all API Logs
`persona_admin_list_all_connect_connections`	List all Connections
`persona_admin_list_all_devices`	List all Devices
`persona_admin_list_all_events`	List all Events
`persona_admin_list_all_importers`	List all Importers
`persona_admin_list_all_rate_limits`	List all Rate Limits
`persona_admin_list_all_share_tokens`	List all Share Tokens
`persona_admin_list_all_user_audit_logs`	List all User Audit Logs
`persona_admin_list_all_webhooks`	List all Webhooks
`persona_admin_list_all_workflow_runs`	List all Workflow Runs
`persona_admin_reactivate_a_connect_connection`	Reactivate a Connection
`persona_admin_redeem_share_token`	Redeem a Share Token
`persona_admin_retrieve_a_connect_connection`	Retrieve a Connect Connection
`persona_admin_retrieve_a_device`	Retrieve a Device
`persona_admin_retrieve_a_graph_query`	Retrieve a Graph Query
`persona_admin_retrieve_a_share_token`	Retrieve a Share Token
`persona_admin_retrieve_a_user_audit_log`	Retrieve a User Audit Log
`persona_admin_retrieve_a_webhook`	Retrieve a Webhook
`persona_admin_retrieve_a_workflow_run`	Retrieve a Workflow Run
`persona_admin_retrieve_an_api_key`	Retrieve an API key
`persona_admin_retrieve_an_api_log`	Retrieve an API Log
`persona_admin_retrieve_an_event`	Retrieve an Event
`persona_admin_retrieve_an_importer`	Retrieve an Importer
`persona_admin_rotate_a_webhook_secret`	Rotate a Webhook’s secret
`persona_admin_update_a_connect_connection`	Update a Connect Connection
`persona_admin_update_a_webhook`	Update a Webhook
`persona_admin_update_an_api_key`	Update an API key

persona_admin_archive_a_webhook

Archive a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	Webhook’s ID (starts with “wbh_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "Webhook's ID (starts with \"wbh_\")"
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_clone_a_webhook

Clone a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	The ID of the Webhook to clone (starts with “wbh_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "The ID of the Webhook to clone (starts with \"wbh_\")"
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_clone_api_key

Clone an API key Parameters:

Parameter	Type	Required	Default	Description
`api-key-id`	string	Yes	—	The token/ID of the API key to be cloned.
`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 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 for more details.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "api-key-id": {
      "type": "string",
      "description": "The token/ID of the API key to be cloned."
    },
    "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."
    }
  },
  "required": [
    "PCID",
    "api-key-id"
  ]
}

persona_admin_create_a_connect_connection

Create a Connection Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`data`	object	No	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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": {
          "description": "The attributes value"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_create_a_graph_query

Create a Graph Query Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value
`meta`	object	No	—	The meta value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    },
    "meta": {
      "type": "object",
      "description": "The meta value",
      "properties": {
        "run-sync": {
          "type": "boolean",
          "description": "If true, the query will run synchronously and results will be returned in the response. If false, the query will run asynchronously and you will have to poll for results."
        }
      }
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_create_a_share_token

Create a Share Token Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_create_a_webhook

Create a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_create_a_workflow_run

Create a Workflow Run Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`workflow-id`	string	Yes	—	The workflow-id value
`data`	object	Yes	—	The data value
`meta`	object	No	—	The meta value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "workflow-id": {
      "type": "string",
      "description": "The workflow-id value"
    },
    "data": {
      "type": "object",
      "description": "The data value",
      "properties": {
        "attributes": {
          "type": "object",
          "description": "JSON key-value pairs of field name to field value. Schema is defined by the trigger payload schema on your Workflow Version."
        }
      },
      "required": [
        "attributes"
      ]
    },
    "meta": {
      "type": "object",
      "description": "The meta value",
      "properties": {
        "params": {
          "type": "object",
          "description": "JSON key-value pairs of field name to field value. Schema is defined by the trigger payload schema on your Workflow Version."
        }
      }
    }
  },
  "required": [
    "PCID",
    "workflow-id",
    "data"
  ]
}

persona_admin_create_an_api_key

Create an API key Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_deactivate_a_connect_connection

Deactivate a Connect Connection Parameters:

Parameter	Type	Required	Default	Description
`connection-id`	string	Yes	—	ID of the connect connection

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "connection-id": {
      "type": "string",
      "description": "ID of the connect connection"
    }
  },
  "required": [
    "PCID",
    "connection-id"
  ]
}

persona_admin_disable_a_webhook

Disable a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	Webhook’s ID (starts with “wbh_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "Webhook's ID (starts with \"wbh_\")"
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_enable_a_webhook

Enable a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	Webhook’s ID (starts with “wbh_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "Webhook's ID (starts with \"wbh_\")"
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_expire_an_api_key

Expire an API key Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`api-key-id`	string	Yes	—	API key’s ID (starts with “api_“)
`meta`	object	Yes	—	The meta value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "api-key-id": {
      "type": "string",
      "description": "API key's ID (starts with \"api_\")"
    },
    "meta": {
      "type": "object",
      "description": "The meta value",
      "properties": {
        "expires-in-seconds": {
          "type": "integer",
          "description": "Number of seconds from now to expire the key (max of 30 days)"
        }
      },
      "required": [
        "expires-in-seconds"
      ]
    }
  },
  "required": [
    "PCID",
    "api-key-id",
    "meta"
  ]
}

persona_admin_expire_share_token

Expire a Share Token Parameters:

Parameter	Type	Required	Default	Description
`share-token-id`	string	Yes	—	The token/ID of the Share Token to be expired.
`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 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 for more details.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "share-token-id": {
      "type": "string",
      "description": "The token/ID of the Share Token to be expired."
    },
    "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."
    }
  },
  "required": [
    "PCID",
    "share-token-id"
  ]
}

persona_admin_import_an_account

Import Accounts Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_import_email_address_lists

Import Email Address Lists Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_import_geolocation_lists

Import Geolocation Lists Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_import_government_id_number_lists

Import Government ID Number Lists Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_import_ip_address_lists

Import IP Address Lists Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_import_name_lists

Import Name Lists Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_import_phone_number_lists

Import Phone Number Lists Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

persona_admin_list_all_api_keys

List all API keys Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`filter`	object	No	—	The filter value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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": {
        "name": {
          "type": "string",
          "description": "Filter API keys by name"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_api_logs

List all API Logs Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_connect_connections

List all Connections Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`filter`	object	No	—	The filter value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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 connections by status"
        },
        "destination-organization-id": {
          "type": "string",
          "description": "Filter connections by authorized organization ID"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_devices

List all Devices Parameters:

Parameter	Type	Required	Default	Description
`filter`	object	Yes	—	The filter value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "object",
      "description": "The filter value",
      "properties": {
        "inquiry-session-id": {
          "type": "string",
          "description": "Filter devices by inquiry session ID"
        }
      },
      "required": [
        "inquiry-session-id"
      ]
    }
  },
  "required": [
    "PCID",
    "filter"
  ]
}

persona_admin_list_all_events

List all Events Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`filter`	object	No	—	The filter value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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": {
        "name": {
          "type": "string",
          "description": "Comma separated list of event names"
        },
        "object-id": {
          "type": "string",
          "description": "Comma separated list of object ids"
        },
        "id": {
          "type": "string",
          "description": "Comma separated list of event ids"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_importers

List all Importers Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_rate_limits

List all Rate Limits

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_share_tokens

List all Share Tokens Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`filter`	object	No	—	The filter value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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": {
        "connection-id": {
          "type": "string",
          "description": "Filter Share Tokens by connect connection ID"
        },
        "status": {
          "type": "string",
          "description": "Filter Share Tokens by status"
        },
        "direction": {
          "type": "string",
          "description": "Filter Share Tokens by direction. Defaults to returning both inbound and outbound."
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_user_audit_logs

List all User Audit Logs Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_webhooks

List all Webhooks Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_list_all_workflow_runs

List all Workflow Runs Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`filter`	object	No	—	The filter value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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 workflow runs by workflow id"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

persona_admin_reactivate_a_connect_connection

Reactivate a Connection Parameters:

Parameter	Type	Required	Default	Description
`connection-id`	string	Yes	—	ID of the connect connection

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "connection-id": {
      "type": "string",
      "description": "ID of the connect connection"
    }
  },
  "required": [
    "PCID",
    "connection-id"
  ]
}

persona_admin_redeem_share_token

Redeem a Share Token Parameters:

Parameter	Type	Required	Default	Description
`share-token-id`	string	Yes	—	The token/ID of the Share Token to be redeemed.
`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 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 for more details.
`data`	object	No	—	The data value
`meta`	object	No	—	The meta value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "share-token-id": {
      "type": "string",
      "description": "The token/ID of the Share Token to be redeemed."
    },
    "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",
      "properties": {
        "field-mappings": {
          "type": "array",
          "description": "Optional list of field mappings to apply when importing source data. If a source field name matches the destination field name, it is copied directly. These mappings are applied for fields not already matched by name."
        }
      }
    }
  },
  "required": [
    "PCID",
    "share-token-id"
  ]
}

persona_admin_retrieve_a_connect_connection

Retrieve a Connect Connection Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`connection-id`	string	Yes	—	Token of the connect connection

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "connection-id": {
      "type": "string",
      "description": "Token of the connect connection"
    }
  },
  "required": [
    "PCID",
    "connection-id"
  ]
}

persona_admin_retrieve_a_device

Retrieve a Device Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`device-id`	string	Yes	—	Device ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "device-id": {
      "type": "string",
      "description": "Device ID"
    }
  },
  "required": [
    "PCID",
    "device-id"
  ]
}

persona_admin_retrieve_a_graph_query

Retrieve a Graph Query Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`graph-query-id`	string	Yes	—	The graph-query-id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "graph-query-id": {
      "type": "string",
      "description": "The graph-query-id value"
    }
  },
  "required": [
    "PCID",
    "graph-query-id"
  ]
}

persona_admin_retrieve_a_share_token

Retrieve a Share Token Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`share-token-id`	string	Yes	—	The ID of the Share Token

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "share-token-id": {
      "type": "string",
      "description": "The ID of the Share Token"
    }
  },
  "required": [
    "PCID",
    "share-token-id"
  ]
}

persona_admin_retrieve_a_user_audit_log

Retrieve a User Audit Log Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`user-audit-log-id`	string	Yes	—	The user-audit-log-id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "user-audit-log-id": {
      "type": "string",
      "description": "The user-audit-log-id value"
    }
  },
  "required": [
    "PCID",
    "user-audit-log-id"
  ]
}

persona_admin_retrieve_a_webhook

Retrieve a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	Webhook’s ID (starts with “wbh_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "Webhook's ID (starts with \"wbh_\")"
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_retrieve_a_workflow_run

Retrieve a Workflow Run Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`workflow-run-id`	string	Yes	—	Workflow Run’s ID (starts with “wfr_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "workflow-run-id": {
      "type": "string",
      "description": "Workflow Run's ID (starts with \"wfr_\")"
    }
  },
  "required": [
    "PCID",
    "workflow-run-id"
  ]
}

persona_admin_retrieve_an_api_key

Retrieve an API key Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`api-key-id`	string	Yes	—	API key’s ID (starts with “api_“)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "api-key-id": {
      "type": "string",
      "description": "API key's ID (starts with \"api_\")"
    }
  },
  "required": [
    "PCID",
    "api-key-id"
  ]
}

persona_admin_retrieve_an_api_log

Retrieve an API Log Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`api-log-id`	string	Yes	—	The api-log-id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "api-log-id": {
      "type": "string",
      "description": "The api-log-id value"
    }
  },
  "required": [
    "PCID",
    "api-log-id"
  ]
}

persona_admin_retrieve_an_event

Retrieve an Event Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`event-id`	string	Yes	—	The event-id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "event-id": {
      "type": "string",
      "description": "The event-id value"
    }
  },
  "required": [
    "PCID",
    "event-id"
  ]
}

persona_admin_retrieve_an_importer

Retrieve an Importer Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`importer-id`	string	Yes	—	String ID of the importer to fetch

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "importer-id": {
      "type": "string",
      "description": "String ID of the importer to fetch"
    }
  },
  "required": [
    "PCID",
    "importer-id"
  ]
}

persona_admin_rotate_a_webhook_secret

Rotate a Webhook’s secret Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	Webhook’s ID (starts with “wbh_“)
`meta`	object	No	—	The meta value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "Webhook's ID (starts with \"wbh_\")"
    },
    "meta": {
      "type": "object",
      "description": "The meta value",
      "properties": {
        "expires-in-seconds": {
          "type": "integer",
          "description": "Seconds until currently active webhook expires"
        }
      }
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_update_a_connect_connection

Update a Connect Connection Parameters:

Parameter	Type	Required	Default	Description
`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 for more details.
`connection-id`	string	Yes	—	Token of the connect connection
`data`	object	No	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "connection-id": {
      "type": "string",
      "description": "Token of the connect connection"
    },
    "data": {
      "type": "object",
      "description": "The data value",
      "properties": {
        "attributes": {
          "description": "The attributes value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "connection-id"
  ]
}

persona_admin_update_a_webhook

Update a Webhook Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`webhook-id`	string	Yes	—	Webhook’s ID (starts with “wbh_“)
`data`	object	No	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "webhook-id": {
      "type": "string",
      "description": "Webhook's ID (starts with \"wbh_\")"
    },
    "data": {
      "type": "object",
      "description": "The data value",
      "properties": {
        "attributes": {
          "type": "object",
          "description": "The attributes value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "webhook-id"
  ]
}

persona_admin_update_an_api_key

Update an API key Parameters:

Parameter	Type	Required	Default	Description
`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 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 for more details.
`api-key-id`	string	Yes	—	API key’s ID (starts with “api_“)
`data`	object	Yes	—	The data value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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."
    },
    "api-key-id": {
      "type": "string",
      "description": "API key's ID (starts with \"api_\")"
    },
    "data": {
      "type": "object",
      "description": "The data value",
      "properties": {
        "attributes": {
          "type": "object",
          "description": "The attributes value"
        }
      },
      "required": [
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "api-key-id",
    "data"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Skills Guides

​Tools

​persona_admin_archive_a_webhook

​persona_admin_clone_a_webhook

​persona_admin_clone_api_key

​persona_admin_create_a_connect_connection

​persona_admin_create_a_graph_query

​persona_admin_create_a_share_token

​persona_admin_create_a_webhook

​persona_admin_create_a_workflow_run

​persona_admin_create_an_api_key

​persona_admin_deactivate_a_connect_connection

​persona_admin_disable_a_webhook

​persona_admin_enable_a_webhook

​persona_admin_expire_an_api_key

​persona_admin_expire_share_token

​persona_admin_import_an_account

​persona_admin_import_email_address_lists

​persona_admin_import_geolocation_lists

​persona_admin_import_government_id_number_lists

​persona_admin_import_ip_address_lists

​persona_admin_import_name_lists

​persona_admin_import_phone_number_lists

​persona_admin_list_all_api_keys

​persona_admin_list_all_api_logs

​persona_admin_list_all_connect_connections

​persona_admin_list_all_devices

​persona_admin_list_all_events

​persona_admin_list_all_importers

​persona_admin_list_all_rate_limits

​persona_admin_list_all_share_tokens

​persona_admin_list_all_user_audit_logs

​persona_admin_list_all_webhooks

​persona_admin_list_all_workflow_runs

​persona_admin_reactivate_a_connect_connection

​persona_admin_redeem_share_token

​persona_admin_retrieve_a_connect_connection

​persona_admin_retrieve_a_device

​persona_admin_retrieve_a_graph_query

​persona_admin_retrieve_a_share_token

​persona_admin_retrieve_a_user_audit_log

​persona_admin_retrieve_a_webhook

​persona_admin_retrieve_a_workflow_run

​persona_admin_retrieve_an_api_key

​persona_admin_retrieve_an_api_log

​persona_admin_retrieve_an_event

​persona_admin_retrieve_an_importer

​persona_admin_rotate_a_webhook_secret

​persona_admin_update_a_connect_connection

​persona_admin_update_a_webhook

​persona_admin_update_an_api_key

Tools

persona_admin_archive_a_webhook

persona_admin_clone_a_webhook

persona_admin_clone_api_key

persona_admin_create_a_connect_connection

persona_admin_create_a_graph_query

persona_admin_create_a_share_token

persona_admin_create_a_webhook

persona_admin_create_a_workflow_run

persona_admin_create_an_api_key

persona_admin_deactivate_a_connect_connection

persona_admin_disable_a_webhook

persona_admin_enable_a_webhook

persona_admin_expire_an_api_key

persona_admin_expire_share_token

persona_admin_import_an_account

persona_admin_import_email_address_lists

persona_admin_import_geolocation_lists

persona_admin_import_government_id_number_lists

persona_admin_import_ip_address_lists

persona_admin_import_name_lists

persona_admin_import_phone_number_lists

persona_admin_list_all_api_keys

persona_admin_list_all_api_logs

persona_admin_list_all_connect_connections

persona_admin_list_all_devices

persona_admin_list_all_events

persona_admin_list_all_importers

persona_admin_list_all_rate_limits

persona_admin_list_all_share_tokens

persona_admin_list_all_user_audit_logs

persona_admin_list_all_webhooks

persona_admin_list_all_workflow_runs

persona_admin_reactivate_a_connect_connection

persona_admin_redeem_share_token

persona_admin_retrieve_a_connect_connection

persona_admin_retrieve_a_device

persona_admin_retrieve_a_graph_query

persona_admin_retrieve_a_share_token

persona_admin_retrieve_a_user_audit_log

persona_admin_retrieve_a_webhook

persona_admin_retrieve_a_workflow_run

persona_admin_retrieve_an_api_key

persona_admin_retrieve_an_api_log

persona_admin_retrieve_an_event

persona_admin_retrieve_an_importer

persona_admin_rotate_a_webhook_secret

persona_admin_update_a_connect_connection

persona_admin_update_a_webhook

persona_admin_update_an_api_key