Skip to main content
Register for live online SeeClickFix Trainings | Learn More...

Search

We are excited to announce the launch of updated product names, logos, and headers within our user interfaces as part of the CivicPlus® Solution Rebranding initiative. These changes mark the first step toward creating a cohesive and seamless user experience across all solutions in our portfolio. As part of this transition, users may notice minor design updates. While the functionality you rely on remains unchanged, we are in the process of updating screenshots and other resources on our Help Centers to reflect the new branding. We appreciate your patience and understanding as we work to complete these updates.

SeeClickFix API Information

  • Updated:

SeeClickFix 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 APIv2
  • SeeClickFix 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.

 

Note: CivicPlus does not provide custom development services or consultation on using the APIs. CivicPlus only provides access to the three APIs listed above.

 

Private Organizational API

If your organization has the private organizational API, you can find information with 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 page location within navigation

 

API Authentication

Authentication for access to the SeeClickFix API utilizes the user's CivicPlus Account Personal Access Token.  Users can now create Personal Access Tokens for authentication to SeeClickFix APIs, by visiting their CivicPlus Account Password & Security page.  

 

The SeeClickFix 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 login to CivicPlus Single Sign, please see the CivicPlus Single Sign On Login Experience article. All new users on SeeClickFix are automatically set up with CivicPlus Single Sign On. 

 

Here are the steps for users to authenticate to SeeClickFix APIs:

  1. Visit your SeeClickFix account preferences.
  2. Navigate to the API page and click the link to the CivicPlus Account Password & Security page.
  3. Create a Personal Access Token and immediately copy the full string value.
  4. Pass the CP token in an HTTP Authorization header on your API requests, as follows:
    Authorization: Bearer <CP-Personal-Access-Token>

 

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 “<ORG ID>”. 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/<ORG ID>/issues
  • Get Request (by ID): https://seeclickfix.com/api/v2/organizations/<ORG ID>/issues/<REQUEST ID>
  • Get Request Comments: https://seeclickfix.com/api/v2/organizations/<ORG ID>/issues/<REQUEST ID> /comments
  • Get Agencies: https://seeclickfix.com/api/v2/organizations/<ORG ID>/zones
  • Get Request Categories: https://seeclickfix.com/api/v2/organizations/<ORG ID>/zones/<ZONE ID>/request_types
  • Get Request Category Q&A: https://seeclickfix.com/api/v2/request_types/<REQUEST CATEGORY ID>
  • Requests List Filtered by Category: https://seeclickfix.com/api/v2/organizations/<ORG ID>/issues?request_types=<REQUEST CATEGORY ID>

 

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/<ORG ID>/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/<ORG ID>/issues?request_types=<REQUEST CATEGORY ID>&after=2023-12-01T08%3A00%3A00.000Z 

 

In-Article Glossary

Review the Help Center Glossary a comprehensive explanation of the acronyms, abbreviations, and company-specific terminology. The terms located in this section are listed alphabetically.

  • API: Application Programming Interface
  • CP: CivicPlus
  • CRM: Customer Relationship Manager
  • HTTP: Hypertext Transfer Protocol

Comments

Let us know what was helpful or not helpful about the article.

0 comments

Please sign in to leave a comment.