Your organization can use Case IQ's public API to bring data from your third-party systems into Case IQ in near real-time. Our API uses a service account in your application to create and update records in your Case IQ system. You must add a service account to use our public API.

To add a service account:

1. Navigate to the Access tab under Settings.
2. Select “User Profile” from the page dropdown menu. 
3. Click the Add Service Account button to load the New Service Account form.
4. Complete the following fields on the New Service Account form.
   1. User ID: set a unique ID or username to authenticate the service account. 
   2. User Role: select the service account's level of access. The user role will determine what the API can do in your application. 
      1. For example, if the service account does not have permissions to view parties, the API cannot update parties in the system. See Manage a User Role for details on adding and editing user roles.
   3. First Name and Last Name: you can enter a first and last name for the service account. We recommend using the name of the individual managing the API integration.
   4. Email: you can enter an email to receive notifications when the service account's API keys will expire soon. This email address will not be used to authenticate the service account.
   5. Phone Number: you can enter a phone number for the service account. We recommend using the phone number for the individual managing the API integration.
   6. Language: set the language interface for the service account. The default is English.
   7. Signature: you can create an email signature for the service account. The user will be able to add the signature text you set when composing an email in Case IQ (see Change Account Settings on Profile Page for details on creating signatures).
5. Click the Save button to finish creating the account. 

When you save the service account, Case IQ will generate two API keys in the API Credentials tab. Use these keys to authorize access for the service account.

Edit a Service Account

If you have permission to edit service accounts, use the following steps to update a service account:

1. On the User Profiles page, click the service account's row in the grid.
2. Click the Edit button.
3. The service account's page will now be in edit mode. You can now update the account's fields.
4. When you have completed your changes, click the Save button.

Activate or Deactivate a Service Account

You can deactivate an active service account or reactivate an inactive account at any time. The API will not be able to sync with Case IQ using an inactive service account. However, all records created or updated via the API will remain in the system.

To deactivate a service account:

1. On the service account's page, click the Options () button.
2. Select the “Deactivate” option.
3. Click Yes on the confirmation pop-up to proceed with deactivating the account.

The service account’s page will now have an “Inactive” flag and a warning banner. To reactivate the account, click the link in the warning banner or the “Activate” option in the Options button menu.

View a Service Account's History

The History tab on the service account’s page displays a list of all actions that have been performed on the account record. Actions completed by the service account are recorded on the Activity tab. The History grid cannot be exported as it contains multiple data types. The History grid has the following columns:

• User: identifies the user who performed the action.
• Action: describes the type of task that occurred.
• Changes: shows the field values that were changed in the action, detailing the original value (“from” in History row) and the value following the change (“To”).
• Date: the date and time when the action occurred. 
• Source IP: the IP address of the device that the individual used to perform the action.

View a Service Account's Sessions

The system tracks login session information each time a service account accesses the application for security purposes. The Sessions tab on the service account’s page displays a list of login activity, including the IP address from which the API call originated, the login time, and the session ID. 

View a Service Account's Activity

Case IQ tracks all actions a service account performs in the Activity tab, so you can monitor everything that the API has done in the application. The Activity grid has the following columns:

• Action: describes the type of task that occurred.
• Changes: shows the field values that were changed in the action, detailing the original value (“from” in Activity row) and the value following the change (“To”).
• Reference: if the action was not performed on the record itself, but on an associated form or record of the case, this column provides more information on the record where the action was completed.
• Date: the date and time when the action occurred.
• Source IP: the IP address from which the API call originated.
• User Agent: the browser details, operating system and version, and device type that the individual used to perform the action.