Skip to content
Rolodex
/
/
Looks up a social profile...

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

Searches for organizations using predefined parameters

Request

Searches for organizations using predefined parameters

Security
knox-authorizer
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 organization that you would like to be saved.

citystring(City)

City to search

domain_namestring(Domain Name)

The domain name

idsArray of strings(Ids)

IDs to search

namestring(Name)

The name

numberArray of numbers(float)(Number)
statestring(State)

The state

statusArray of strings(Status)
type_idstring(Type)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizations/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "city": "string",
    "domain_name": "string",
    "ids": [
      "string"
    ],
    "name": "string",
    "number": [
      0.1
    ],
    "state": "string",
    "status": [
      "string"
    ],
    "type_id": "string"
  }'

Responses

The organization search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(OrganizationSearchResults)
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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed

domainstringrequired

The domain to look up

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizations/{tenantId}/socialProfile/{domain}' \
  -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
biostring(Bio)

Bio/Notes

categorystring(Category)

Category

detailsobject(Details)
employeesnumber(float)(Employees)

Number of employees

facebookstring(Facebook)

Facebook url

foundednumber(float)(Founded)

Year founded

linkedinstring(Linkedin)

Linked in Profile

localestring(Locale)

Organization locale

locationstring(Location)

Location of the organization

logostring(Logo)

The logo

namestring(Name)

Name of the organization

twitterstring(Twitter)

Twitter handle

Response
application/json
{
  "bio": "string",
  "category": "string",
  "details": {
    "locations": [ … ],
    "phones": [ … ]
  },
  "employees": 0.1,
  "facebook": "string",
  "founded": 0.1,
  "linkedin": "string",
  "locale": "string",
  "location": "string",
  "logo": "string",
  "name": "string",
  "twitter": "string"
}

Returns a organization from the system by its ID.

Request

This method will delete a organization with the specified ID.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the organization to delete.

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

Responses

The organization was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

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