affinda-workspace

Affinda Workspace - organizations, workspaces, data sources, tags, and webhooks

Server path: /affinda-workspace | Type: Application | PCID required: Yes

Tools

Tool	Description
affinda_workspace_add_mapping_data_source_value	Add value for a data source
affinda_workspace_batch_add_tag	Add a tag to documents
affinda_workspace_batch_remove_tag	Remove a tag from documents
affinda_workspace_create_invitation	Create a new invitation
affinda_workspace_create_mapping_data_source	Create a data source
affinda_workspace_create_resthook_subscription	Create a resthook subscription
affinda_workspace_create_tag	Create a tag
affinda_workspace_create_workspace	Create a workspace
affinda_workspace_create_workspace_membership	Create a workspace membership
affinda_workspace_delete_invitation	Delete an invitation
affinda_workspace_delete_mapping_data_source	Delete specific data source
affinda_workspace_delete_mapping_data_source_value	Delete specific data source value
affinda_workspace_delete_membership	Delete a workspace membership
affinda_workspace_delete_resthook_subscription	Delete a resthook subscription
affinda_workspace_delete_tag	Delete an tag
affinda_workspace_delete_workspace	Delete a workspace
affinda_workspace_get_all_invitations	Get list of all invitations
affinda_workspace_get_all_organizations	Get list of all organizations
affinda_workspace_get_all_resthook_subscriptions	Get list of all resthook subscriptions
affinda_workspace_get_all_tags	Get list of all tags
affinda_workspace_get_all_workspace_memberships	Get list of all workspace memberships
affinda_workspace_get_all_workspaces	Get list of all workspaces
affinda_workspace_get_invitation	Get detail of an invitation
affinda_workspace_get_invitation_by_token	Get detail of an invitation by token
affinda_workspace_get_mapping_data_source	Get specific data source
affinda_workspace_get_mapping_data_source_value	Get specific data source value
affinda_workspace_get_membership	Get specific workspace membership
affinda_workspace_get_organization	Get detail of an organization
affinda_workspace_get_resthook_subscription	Get specific resthook subscription
affinda_workspace_get_tag	Get specific tag
affinda_workspace_get_usage_by_workspace	Get usage by workspace
affinda_workspace_get_workspace	Get specific workspace
affinda_workspace_list_mapping_data_source_values	List values for a data source
affinda_workspace_list_mapping_data_sources	List data sources
affinda_workspace_replace_mapping_data_source_values	Replace values for a data source
affinda_workspace_respond_to_invitation	Respond to an invitation
affinda_workspace_update_invitation	Update an invitation
affinda_workspace_update_mapping_data_source_value	Update specific data source value
affinda_workspace_update_resthook_subscription	Update a resthook subscription
affinda_workspace_update_tag	Update a tag
affinda_workspace_update_workspace	Update a workspace

---

affinda_workspace_add_mapping_data_source_value

Add value for a data source

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier
body	object	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Data source's identifier"
    },
    "body": {
      "type": "object",
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "identifier",
    "body"
  ]
}

---

affinda_workspace_batch_add_tag

Add a tag to documents

Parameters:

Parameter	Type	Required	Default	Description
identifiers	string[]	No	—	List of documents to tag
tag	integer	No	—	The tag’s ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifiers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of documents to tag"
    },
    "tag": {
      "type": "integer",
      "description": "The tag's ID"
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_batch_remove_tag

Remove a tag from documents

Parameters:

Parameter	Type	Required	Default	Description
identifiers	string[]	No	—	List of documents to remove tag from
tag	integer	No	—	The tag’s ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifiers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of documents to remove tag from"
    },
    "tag": {
      "type": "integer",
      "description": "The tag's ID"
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_create_invitation

Create a new invitation

Parameters:

Parameter	Type	Required	Default	Description
email	string	Yes	—	The email which the invitation is sent to.
organization	string	Yes	—	Uniquely identify an organization.
role	string	Yes	—	The role value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "email": {
      "type": "string",
      "description": "The email which the invitation is sent to."
    },
    "organization": {
      "type": "string",
      "description": "Uniquely identify an organization."
    },
    "role": {
      "type": "string",
      "description": "The role value",
      "enum": [
        "admin",
        "member"
      ]
    }
  },
  "required": [
    "PCID",
    "email",
    "organization",
    "role"
  ]
}

---

affinda_workspace_create_mapping_data_source

Create a data source

Parameters:

Parameter	Type	Required	Default	Description
displayProperty	string	No	—	Attribute in the schema which is used to display the value
keyProperty	string	No	—	Attribute in the schema which uniquely identifiers the value
name	string	No	—	The name value
organization	string	No	—	The organization that this mapping data source belongs to.
schema	object	No	—	The schema of the mapping data source.
values	object[]	No	—	The values value
workspace	string	No	—	The workspace that this mapping data source belongs to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "displayProperty": {
      "type": "string",
      "description": "Attribute in the schema which is used to display the value"
    },
    "keyProperty": {
      "type": "string",
      "description": "Attribute in the schema which uniquely identifiers the value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "organization": {
      "type": "string",
      "description": "The organization that this mapping data source belongs to."
    },
    "schema": {
      "type": "object",
      "description": "The schema of the mapping data source."
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The values value"
    },
    "workspace": {
      "type": "string",
      "description": "The workspace that this mapping data source belongs to."
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_create_resthook_subscription

Create a resthook subscription

Parameters:

Parameter	Type	Required	Default	Description
event	string	Yes	—	The event name to subscribe to.
organization	string	No	—	The organization value
targetUrl	string	Yes	—	URL of the resthook’s receiver.
version	string	No	—	Version of the resthook subscription. Determines the resthook body being fired.
workspace	string	No	—	The workspace value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "event": {
      "type": "string",
      "description": "The event name to subscribe to.",
      "enum": [
        "resume.parse.succeeded",
        "resume.parse.failed",
        "resume.parse.completed",
        "invoice.parse.succeeded",
        "invoice.parse.failed",
        "invoice.parse.completed",
        "invoice.validate.completed",
        "document.parse.succeeded",
        "document.parse.failed",
        "document.parse.completed",
        "document.validate.completed",
        "document.classify.succeeded",
        "document.classify.failed",
        "document.classify.completed",
        "document.rejected",
        "annotation.validated"
      ]
    },
    "organization": {
      "type": "string",
      "description": "The organization value"
    },
    "targetUrl": {
      "type": "string",
      "description": "URL of the resthook's receiver."
    },
    "version": {
      "type": "string",
      "description": "Version of the resthook subscription. Determines the resthook body being fired.",
      "enum": [
        "v1",
        "v2",
        "v3"
      ]
    },
    "workspace": {
      "type": "string",
      "description": "The workspace value"
    }
  },
  "required": [
    "PCID",
    "event",
    "targetUrl"
  ]
}

---

affinda_workspace_create_tag

Create a tag

Parameters:

Parameter	Type	Required	Default	Description
name	string	Yes	—	The name value
workspace	string	Yes	—	Uniquely identify a workspace.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "workspace": {
      "type": "string",
      "description": "Uniquely identify a workspace."
    }
  },
  "required": [
    "PCID",
    "name",
    "workspace"
  ]
}

---

affinda_workspace_create_workspace

Create a workspace

Parameters:

Parameter	Type	Required	Default	Description
documentSplitter	string	No	—	Uniquely identify a document splitter.
documentTypes	string[]	No	—	Document types to associate with this workspace
name	string	Yes	—	The name value
organization	string	Yes	—	Uniquely identify an organization.
rejectDuplicates	boolean	No	—	If “true”, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If “false”, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
rejectInvalidDocuments	boolean	No	—	If true, the uploaded document will be rejected if it’s of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
visibility	string	No	—	Visibility “organization” means everyone in the organization can access the workspace. Visibility “private” means only people explicitly added can access the workspace.
whitelistIngestAddresses	string[]	No	—	If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. ”*@eyefind.info”.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "documentSplitter": {
      "type": "string",
      "description": "Uniquely identify a document splitter."
    },
    "documentTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Document types to associate with this workspace"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "organization": {
      "type": "string",
      "description": "Uniquely identify an organization."
    },
    "rejectDuplicates": {
      "type": "boolean",
      "description": "If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings."
    },
    "rejectInvalidDocuments": {
      "type": "boolean",
      "description": "If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed."
    },
    "visibility": {
      "type": "string",
      "description": "Visibility \"organization\" means everyone in the organization can access the workspace. Visibility \"private\" means only people explicitly added can access the workspace.",
      "enum": [
        "organization",
        "private"
      ]
    },
    "whitelistIngestAddresses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. \"*@eyefind.info\"."
    }
  },
  "required": [
    "PCID",
    "name",
    "organization"
  ]
}

---

affinda_workspace_create_workspace_membership

Create a workspace membership

Parameters:

Parameter	Type	Required	Default	Description
user	integer	No	—	Uniquely identify a user.
workspace	string	No	—	Uniquely identify a workspace.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user": {
      "type": "integer",
      "description": "Uniquely identify a user."
    },
    "workspace": {
      "type": "string",
      "description": "Uniquely identify a workspace."
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_delete_invitation

Delete an invitation

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Invitation identifier.

Show inputSchema

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

---

affinda_workspace_delete_mapping_data_source

Delete specific data source

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier

Show inputSchema

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

---

affinda_workspace_delete_mapping_data_source_value

Delete specific data source value

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier
value	string	Yes	—	Data Source Value’s value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Data source's identifier"
    },
    "value": {
      "type": "string",
      "description": "Data Source Value's value"
    }
  },
  "required": [
    "PCID",
    "identifier",
    "value"
  ]
}

---

affinda_workspace_delete_membership

Delete a workspace membership

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Workspace membership’s identifier.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Workspace membership's identifier."
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

affinda_workspace_delete_resthook_subscription

Delete a resthook subscription

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	ResthookSubscription’s ID

Show inputSchema

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

---

affinda_workspace_delete_tag

Delete an tag

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Tag’s ID

Show inputSchema

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

---

affinda_workspace_delete_workspace

Delete a workspace

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Workspace’s identifier

Show inputSchema

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

---

affinda_workspace_get_all_invitations

Get list of all invitations

Parameters:

Parameter	Type	Required	Default	Description
offset	integer	No	—	The number of documents to skip before starting to collect the result set.
limit	integer	No	—	The numbers of results to return.
organization	string	No	—	Filter by organization.
status	string	No	—	Filter by status.
role	string	No	—	Filter by role.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of documents to skip before starting to collect the result set."
    },
    "limit": {
      "type": "integer",
      "description": "The numbers of results to return."
    },
    "organization": {
      "type": "string",
      "description": "Filter by organization."
    },
    "status": {
      "type": "string",
      "description": "Filter by status.",
      "enum": [
        "pending",
        "accepted",
        "declined"
      ]
    },
    "role": {
      "type": "string",
      "description": "Filter by role.",
      "enum": [
        "admin",
        "member"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_get_all_organizations

Get list of all organizations

Show inputSchema

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

---

affinda_workspace_get_all_resthook_subscriptions

Get list of all resthook subscriptions

Parameters:

Parameter	Type	Required	Default	Description
offset	integer	No	—	The number of documents to skip before starting to collect the result set.
limit	integer	No	—	The numbers of results to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of documents to skip before starting to collect the result set."
    },
    "limit": {
      "type": "integer",
      "description": "The numbers of results to return."
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_get_all_tags

Get list of all tags

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	The numbers of results to return.
offset	integer	No	—	The number of documents to skip before starting to collect the result set.
workspace	string	No	—	Filter by workspace.
name	string	No	—	Filter by name.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The numbers of results to return."
    },
    "offset": {
      "type": "integer",
      "description": "The number of documents to skip before starting to collect the result set."
    },
    "workspace": {
      "type": "string",
      "description": "Filter by workspace."
    },
    "name": {
      "type": "string",
      "description": "Filter by name."
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_get_all_workspace_memberships

Get list of all workspace memberships

Parameters:

Parameter	Type	Required	Default	Description
offset	integer	No	—	The number of documents to skip before starting to collect the result set.
limit	integer	No	—	The numbers of results to return.
workspace	string	No	—	Filter by workspace.
user	string	No	—	Partial text match on user’s email, case-insensitive.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of documents to skip before starting to collect the result set."
    },
    "limit": {
      "type": "integer",
      "description": "The numbers of results to return."
    },
    "workspace": {
      "type": "string",
      "description": "Filter by workspace."
    },
    "user": {
      "type": "string",
      "description": "Partial text match on user's email, case-insensitive."
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_get_all_workspaces

Get list of all workspaces

Parameters:

Parameter	Type	Required	Default	Description
organization	string	Yes	—	Filter by organization.
name	string	No	—	Filter by name.

Show inputSchema

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

---

affinda_workspace_get_invitation

Get detail of an invitation

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Invitation identifier.

Show inputSchema

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

---

affinda_workspace_get_invitation_by_token

Get detail of an invitation by token

Parameters:

Parameter	Type	Required	Default	Description
token	string	Yes	—	Invitation token.

Show inputSchema

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

---

affinda_workspace_get_mapping_data_source

Get specific data source

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier

Show inputSchema

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

---

affinda_workspace_get_mapping_data_source_value

Get specific data source value

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier
value	string	Yes	—	Data Source Value’s value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Data source's identifier"
    },
    "value": {
      "type": "string",
      "description": "Data Source Value's value"
    }
  },
  "required": [
    "PCID",
    "identifier",
    "value"
  ]
}

---

affinda_workspace_get_membership

Get specific workspace membership

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Workspace membership’s identifier.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Workspace membership's identifier."
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

affinda_workspace_get_organization

Get detail of an organization

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Organization identifier.

Show inputSchema

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

---

affinda_workspace_get_resthook_subscription

Get specific resthook subscription

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Resthook subscription’s ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Resthook subscription's ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

affinda_workspace_get_tag

Get specific tag

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Tag’s ID

Show inputSchema

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

---

affinda_workspace_get_usage_by_workspace

Get usage by workspace

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Workspace’s identifier
start	string	No	—	Start date of the period to retrieve. Format: YYYY-MM
end	string	No	—	End date of the period to retrieve. Format: YYYY-MM

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Workspace's identifier"
    },
    "start": {
      "type": "string",
      "description": "Start date of the period to retrieve. Format: YYYY-MM"
    },
    "end": {
      "type": "string",
      "description": "End date of the period to retrieve. Format: YYYY-MM"
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

affinda_workspace_get_workspace

Get specific workspace

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Workspace’s identifier

Show inputSchema

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

---

affinda_workspace_list_mapping_data_source_values

List values for a data source

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	The numbers of results to return.
offset	integer	No	—	The number of documents to skip before starting to collect the result set.
search	string	No	—	Search for specific values
annotation	integer	No	—	Filter based on annotation ID
document	string	No	—	Identifier of the document to apply filter lookups on if available
identifier	string	Yes	—	Data source’s identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The numbers of results to return."
    },
    "offset": {
      "type": "integer",
      "description": "The number of documents to skip before starting to collect the result set."
    },
    "search": {
      "type": "string",
      "description": "Search for specific values"
    },
    "annotation": {
      "type": "integer",
      "description": "Filter based on annotation ID"
    },
    "document": {
      "type": "string",
      "description": "Identifier of the document to apply filter lookups on if available"
    },
    "identifier": {
      "type": "string",
      "description": "Data source's identifier"
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

affinda_workspace_list_mapping_data_sources

List data sources

Parameters:

Parameter	Type	Required	Default	Description
offset	integer	No	—	The number of documents to skip before starting to collect the result set.
limit	integer	No	—	The numbers of results to return.
name	string	No	—	Filter by name.
organization	string	No	—	Filter by organization.
workspace	string	No	—	Filter by workspace.
identifier	string	No	—	Filter by identifier.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "offset": {
      "type": "integer",
      "description": "The number of documents to skip before starting to collect the result set."
    },
    "limit": {
      "type": "integer",
      "description": "The numbers of results to return."
    },
    "name": {
      "type": "string",
      "description": "Filter by name."
    },
    "organization": {
      "type": "string",
      "description": "Filter by organization."
    },
    "workspace": {
      "type": "string",
      "description": "Filter by workspace."
    },
    "identifier": {
      "type": "string",
      "description": "Filter by identifier."
    }
  },
  "required": [
    "PCID"
  ]
}

---

affinda_workspace_replace_mapping_data_source_values

Replace values for a data source

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier
body	object[]	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Data source's identifier"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "identifier",
    "body"
  ]
}

---

affinda_workspace_respond_to_invitation

Respond to an invitation

Parameters:

Parameter	Type	Required	Default	Description
token	string	Yes	—	Invitation token.
status	string	No	—	The status value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "token": {
      "type": "string",
      "description": "Invitation token."
    },
    "status": {
      "type": "string",
      "description": "The status value",
      "enum": [
        "accepted",
        "declined"
      ]
    }
  },
  "required": [
    "PCID",
    "token"
  ]
}

---

affinda_workspace_update_invitation

Update an invitation

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Invitation identifier.
role	string	No	—	The role value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Invitation identifier."
    },
    "role": {
      "type": "string",
      "description": "The role value",
      "enum": [
        "admin",
        "member"
      ]
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}

---

affinda_workspace_update_mapping_data_source_value

Update specific data source value

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Data source’s identifier
value	string	Yes	—	Data Source’s value
body	object	Yes	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Data source's identifier"
    },
    "value": {
      "type": "string",
      "description": "Data Source's value"
    },
    "body": {
      "type": "object",
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "identifier",
    "value",
    "body"
  ]
}

---

affinda_workspace_update_resthook_subscription

Update a resthook subscription

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	ResthookSubscription’s ID
event	string	No	—	The event name to subscribe to.
organization	string	No	—	Uniquely identify an organization.
version	string	No	—	Version of the resthook subscription. Determines the resthook body being fired.
workspace	string	No	—	Uniquely identify a workspace.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ResthookSubscription's ID"
    },
    "event": {
      "type": "string",
      "description": "The event name to subscribe to.",
      "enum": [
        "resume.parse.succeeded",
        "resume.parse.failed",
        "resume.parse.completed",
        "invoice.parse.succeeded",
        "invoice.parse.failed",
        "invoice.parse.completed",
        "invoice.validate.completed",
        "document.parse.succeeded",
        "document.parse.failed",
        "document.parse.completed",
        "document.validate.completed",
        "document.classify.succeeded",
        "document.classify.failed",
        "document.classify.completed",
        "document.rejected",
        "annotation.validated"
      ]
    },
    "organization": {
      "type": "string",
      "description": "Uniquely identify an organization."
    },
    "version": {
      "type": "string",
      "description": "Version of the resthook subscription. Determines the resthook body being fired.",
      "enum": [
        "v1",
        "v2",
        "v3"
      ]
    },
    "workspace": {
      "type": "string",
      "description": "Uniquely identify a workspace."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

affinda_workspace_update_tag

Update a tag

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	Tag’s ID
name	string	No	—	The name value
workspace	string	No	—	Uniquely identify a workspace.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Tag's ID"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "workspace": {
      "type": "string",
      "description": "Uniquely identify a workspace."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

affinda_workspace_update_workspace

Update a workspace

Parameters:

Parameter	Type	Required	Default	Description
identifier	string	Yes	—	Workspace’s identifier
documentSplitter	string	No	—	Uniquely identify a document splitter.
documentTypes	string[]	No	—	Document types to associate with this workspace
name	string	No	—	The name value
rejectDuplicates	boolean	No	—	If “true”, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If “false”, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
rejectInvalidDocuments	boolean	No	—	If true, the uploaded document will be rejected if it’s of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
visibility	string	No	—	Visibility “organization” means everyone in the organization can access the workspace. Visibility “private” means only people explicitly added can access the workspace.
whitelistIngestAddresses	string[]	No	—	If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. ”*@eyefind.info”.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "identifier": {
      "type": "string",
      "description": "Workspace's identifier"
    },
    "documentSplitter": {
      "type": "string",
      "description": "Uniquely identify a document splitter."
    },
    "documentTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Document types to associate with this workspace"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "rejectDuplicates": {
      "type": "boolean",
      "description": "If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings."
    },
    "rejectInvalidDocuments": {
      "type": "boolean",
      "description": "If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed."
    },
    "visibility": {
      "type": "string",
      "description": "Visibility \"organization\" means everyone in the organization can access the workspace. Visibility \"private\" means only people explicitly added can access the workspace.",
      "enum": [
        "organization",
        "private"
      ]
    },
    "whitelistIngestAddresses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. \"*@eyefind.info\"."
    }
  },
  "required": [
    "PCID",
    "identifier"
  ]
}