SeeClickFix 311 CRM offers three separate APIs available for requests. In addition to the two public APIs, customer organizations may also purchase a license to have access to a private organizational API. The three APIs are:
Open311
SeeClickFix 311 CRM APIv2
SeeClickFix 311 CRM APIv2 for Organizations
Visit our developer site for complete API documentation. You can also view recommendations on which API to use.
Note:
For clarity, the SeeClickFix 311 CRM APIs do not utilize Webhooks.
CivicPlus does not provide custom development services or consultation on using the APIs. CivicPlus only provides access to the three APIs listed prior.
Private Organizational API
If your organization has the private organizational API, you can find information within your SeeClickFix 311 CRM account settings area under the left-hand navigation for Integrations, then select API. This will provide the URL that links out to the root API itself, which has a variety of endpoints to access specific resources.
API Authentication
Authentication for access to the SeeClickFix 311 CRM API utilizes the user's CivicPlus Account Personal Access Token. Users can now create Personal Access Tokens for authentication to SeeClickFix 311 CRM APIs, by visiting their CivicPlus Account Password and Security page.
The SeeClickFix 311 CRM user must be utilizing CivicPlus Single Sign-On to take advantage of this Token for authentication. If the user needs to be migrated from SeeClickFix 311 CRM login to CivicPlus Single Sign-On, please see the Migrating Users to Single Sign-On article. All new users on SeeClickFix 311 CRM are automatically set up with CivicPlus Single Sign-On.
Here are the steps for users to authenticate to SeeClickFix 311 CRM APIs:
Visit your SeeClickFix 311 CRM account preferences.
Navigate to the API page and click the link to the CivicPlus Account Password & Security page.
Create a Personal Access Token and immediately copy the full string value.
Pass the CivicPlus token in an HTTP Authorization header on your API requests, as follows:Authorization: Bearer
API Calls
For quick reference, here are some example API calls, that might be relevant. In the URL, the SeeClickFix 311 CRM organization account ID needs to replace the "". The ID can be found in the URL of the CRM pages. For example, if a customer URL is https://crm.seeclickfix.com/#/organizations/678/settings, the organizational ID is 678. The same is true for request ID, zone ID, and request category ID, which can be found in the URLs in the appropriate setting location for this item within the CRM.
Get Requests: https://seeclickfix.com/api/v2/organizations//issues
Get Request (by ID): https://seeclickfix.com/api/v2/organizations//issues/>
Get Request Comments: https://seeclickfix.com/api/v2/organizations//issues/ /comments
Get Agencies: https://seeclickfix.com/api/v2/organizations//zones
Get Request Categories: https://seeclickfix.com/api/v2/organizations//zones//request_types
Get Request Category : https://seeclickfix.com/api/v2/request_types/
Requests List Filtered by Category: https://seeclickfix.com/api/v2/organizations//issues?request_types=
It is recommended to first utilize the sandbox environment for SeeClickFix 311 CRM to test setting up and implementation of any use of the API. If using the sandbox, add "int." to the beginning of the above URLs. For example, the Get Requests endpoint would change to:
https://int.seeclickfix.com/api/v2/organizations//issues
The Issues (Requests) list endpoint can be filtered by any of the parameters listed in the Development documentation.
For example, if an organization wanted to filter to a list of requests submitted to a specific category and after a specific date, these parameters can be added to the endpoint. Here's an example of an endpoint for a specific category with requests created after December 1, 2023:
https://seeclickfix.com/api/v2/organizations//issues?request_types=&after=2023-12-01T08%3A00%3A00.000Z