Skip to main content

Getting Started with the Socket API

The Socket API lets you connect Socket to your own systems, so you can create clients and leads from elsewhere and pull proposal and reporting data out.

Written by Amy Mall

The Socket API lets you connect Socket to your own systems, so you can create clients and leads from elsewhere and pull proposal and reporting data out. This guide covers creating an API key, authenticating, making requests, and where to find the full reference.

Creating your API key

Log into Socket, open Practice Settings and choose Integrations.

Choose Show All Available Integrations and scroll down to Socket.

Choose New API Key and select the permissions you need.

The Socket integration on the Integrations page, with the New API Key button and the permissions to select

An API key expires 12 months after it is created, so you need to create a new one each year.

Authenticating your requests

The reference lives at socket-api.readme.io.

Send your API key in the header of each request to authenticate it.

The Socket API reference, showing the header where the API key is entered to authenticate a request

Making requests

The API follows standard REST conventions, and all requests and responses use JSON.

  • GET retrieves data, such as listing proposals or fetching a client's details.

  • POST creates new records, such as adding a lead.

Common uses

  • Create clients and leads from your CRM or ERP system.

  • Retrieve proposal information from Socket for reporting in Excel or your BI tool.

  • Pull reporting data into your BI tools.

Listing proposals with their service lines

GET /api/v2/proposals returns every proposal in any status, including drafts and future-dated wins, with paging. The key needs the proposals:read permission.

  • include=lines adds each proposal's contracted service lines.

  • status[]= filters by status.

  • perPage= sets the page size.

For example, this returns the first 50 proposals with their service lines:

GET /api/v2/proposals?include=lines&perPage=50

The meta.total in the response is the practice's count of proposals, excluding superseded versions. To return the superseded versions as well, add status[]=superseded.

API reference

A full list of endpoints, parameters, and examples is in the Socket API documentation.

Support

For any queries, contact [email protected].

Related articles

Did this answer your question?