Use this reference when you build a CRM integration and need the API address or documentation.
The API Address
| Rhythm Account | Address |
|---|---|
| Your live account | https://rolodex.api.rhythmsoftware.com |
| Your sandbox or another non-live Rhythm account | https://rolodex.api.dev.rhythmsoftware.com |
Use this one address for every CRM operation. Add your authorization header and query string to the request, and Rhythm passes them straight through. Responses are not cached, and every call uses an encrypted connection.
The address does not give you access on its own. Each operation still checks your session the same way it does in the Console.
A contact's organization fields and preferred-address fields are already available through this API, so you do not need a separate request or additional development to retrieve them.
The API Documentation
You can read the CRM API documentation without signing in at https://rolodex.api.rhythmsoftware.com/swagger/ and the paths beneath it. After a new version is published, it can take up to about 20 minutes to appear there. The Swagger reference includes the Organizations endpoints and their available request and response fields, not just a sample response.
Searching Contacts and Organizations Through the API
External systems can search for contacts and organizations through the Contacts and Organizations search endpoints, and they can retrieve both built-in and custom fields in the response. Use the fieldsToReturn parameter to return only the fields you need. If you omit it, the endpoint returns the full object. When a search expects an array of emails, you can send one email address as a one-item array.