Find, read, create, update and delete CiviCRM contacts, memberships, groups, activities and relationships through APIv4.
Explore 30 workflow actions for CiviCRM, including account permissions and operation limits.
15 read actions15 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Create a activity
Write
Create a activity.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a contact
Write
Create a contact.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a group
Write
Create a group.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a membership
Write
Create a membership.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a relationship
Write
Create a relationship.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a activity
Write
Delete one activity by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a contact
Write
Delete one contact by ID (CiviCRM moves contacts to the trash unless it is configured otherwise).
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a group
Write
Delete one group by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a membership
Write
Delete one membership by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a relationship
Write
Delete one relationship by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a activity
Read
Get one activity by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
Get a contact
Read
Get one contact by ID, with the fields you name.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
Get a group
Read
Get one group by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
Get a membership
Read
Get one membership by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
Get a relationship
Read
Get one relationship by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List activities
Read
Find activities with APIv4 where clauses, sort order, limit and offset.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List activity fields
Read
List the activity fields (including custom fields) with their names, labels and types.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List contact fields
Read
List the contact fields (including custom fields) with their names, labels and types.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List contacts
Read
Find contacts with APIv4 where clauses, sort order, limit and offset.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List group fields
Read
List the group fields (including custom fields) with their names, labels and types.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List groups
Read
Find groups with APIv4 where clauses, sort order, limit and offset.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List membership fields
Read
List the membership fields (including custom fields) with their names, labels and types.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List memberships
Read
Find memberships with APIv4 where clauses, sort order, limit and offset.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List relationship fields
Read
List the relationship fields (including custom fields) with their names, labels and types.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
List relationships
Read
Find relationships with APIv4 where clauses, sort order, limit and offset.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
Update a activity
Write
Change fields on one activity by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a contact
Write
Change fields on one contact by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a group
Write
Change fields on one group by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a membership
Write
Change fields on one membership by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a relationship
Write
Change fields on one relationship by ID.
Permissions and limits
Account permissions
A CiviCRM user with an API key, the authenticate with api key permission, and access to the records
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in CiviCRM. A saved workflow is not a completed provider action.
CRM ยท CONNECTION
