Rolodex

/

/

Looks up a social profile and returns what is found to the user

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

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

Searches for contacts using predefined parameters

Request

Searches for contacts using predefined parameters

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The contact that you would like to be saved.

citystring(City)

City to search

contact_role_idstring(Contact Role)

countrystring(Country)

The country

email_addressstring(Email Address)

first_namestring(First Name)

idsArray of strings(Ids)

IDs to search

job_titlestring(Job Title)

last_namestring(Last Name)

nicknamestring(Nickname)

numberArray of numbers(float)(Number)

organization_idArray of strings(Organization)

organization_namestring(Organization Name)

statestring(State)

The state

statusArray of strings(Status)

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "city": "string",
    "contact_role_id": "string",
    "country": "string",
    "email_address": "string",
    "first_name": "string",
    "ids": [
      "string"
    ],
    "job_title": "string",
    "last_name": "string",
    "nickname": "string",
    "number": [
      0.1
    ],
    "organization_id": [
      "string"
    ],
    "organization_name": "string",
    "state": "string",
    "status": [
      "string"
    ]
  }'

Responses

The contact search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(ContactSearchResults)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Looks up a social profile and returns what is found to the user

Request

This method will make a call and parse/return the results

Path

tenantIdstringrequired

The id of the tenant being accessed

emailAddressstringrequired

The email address to look up

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

Responses

The social profile was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

avatarstring(Avatar)

A url of the image of the individual

biostring(Bio)

Bio/Notes

detailsobject(Details)

emailAddressstring(Emailaddress)

The primary email address

facebookstring(Facebook)

Facebook url

fullNamestring(Fullname)

The full name

genderstring(Gender)

The discovered gender

Enum"female""male"

linkedinstring(Linkedin)

Linked in Profile

organizationstring(Organization)

The organization the contact belongs to

titlestring(Title)

The job title

twitterstring(Twitter)

Twitter handle

Response

application/json

{
  "avatar": "string",
  "bio": "string",
  "details": {},
  "emailAddress": "string",
  "facebook": "string",
  "fullName": "string",
  "gender": "female",
  "linkedin": "string",
  "organization": "string",
  "title": "string",
  "twitter": "string"
}

Returns a contact from the system by its ID.

Request

This method will delete a contact with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contacts/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The contact was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

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

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