Rolodex
/
Organizations
/
Returns a list of records with the specified parent_organization_id

Rolodex (Contacts & Organizations) (v1-2025-04-18)

The Contacts & Organizations, or Rolodex, app provides the Customer Relationship Management (CRM) capabilities of the Rhythm platform. Common integrations with the Rolodex API include finding or updating contact information, demographics, or communication preferences for a Contact or Organization.

Like most of the other Rhythm apps, the Rolodex API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
rolodex-v1.json
rolodex-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/
https://rolodex.api.rhythmsoftware.com/

Account Delegation Processes

Account Delegation Processes

Operations

Address Types

Address Types

Operations

Communication Types

Communication Types

Operations

Contact Directories

Contact Directories

Operations

Contact Districts

Contact Districts

Operations

Contact Duplicates

Contact Duplicates

Operations

Contact Login Profiles

Contact Login Profiles

Operations

Contact Role Rule Sets

Contact Role Rule Sets

Operations

Contact Roles

Contact Roles

Operations

Contacts

Contacts

Operations

Custom Activities

Custom Activities

Operations

Custom Activity Types

Custom Activity Types

Operations

Custom Engagement Metrics

Custom Engagement Metrics

Operations

Engagement Categories

Engagement Categories

Operations

Engagement Models

Engagement Models

Operations

Engagement Scores

Engagement Scores

Operations

Organization Directories

Organization Directories

Operations

Organization Duplicates

Organization Duplicates

Operations

Organization Types

Organization Types

Operations

Organizations

Organizations

Operations

Finds all conflicting fields for organizations

Request

This method will load organizations, compare them, and return all fields that are in conflict

Path
tenantIdstringrequired

The id of the tenant being accessed

idsstringrequired

Comma-separated listo fIDS

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizations/{tenantId}/getFieldConflicts/{ids}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Conflicts were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
conflicting_fieldsArray of strings
contactsArray of objects(Contact)
organizationsArray of objects(Organization)
Response
application/json
{
  "conflicting_fields": [
    "string"
  ],
  "contacts": [
    { … }
  ],
  "organizations": [
    { … }
  ]
}

Returns a list of records with the specified parent_organization_id

Request

Returns a list of records with the specified parent_organization_id

Path
tenantIdstringrequired

The tenant

parent_organization_idstringrequired

The parent_organization_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizations/{tenantId}/parentOrganization/{parent_organization_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Organization)
LastEvaluatedKeystring
Response
application/json
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Request

Sends out a preview of the CRC notification email

Path
tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

contact_idstring(Contact)required
destination_email_addressstring(Destination Email Address)required
email_templateobject(Email Template)
organization_idstring(Organization)required
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizations/{tenantId}/previewContactRoleComplianceEmail' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact_id": "string",
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "organization_id": "string"
  }'

Responses

The record was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Phone Number Types

Phone Number Types

Operations

Query Definitions

Query Definitions

Operations

Region Configurations

Region Configurations

Operations

Regions

Regions

Operations

Relationship Types

Relationship Types

Operations

Relationships

Relationships

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations