Organizations

Organizations

Creates a new organization record that does not already exist.

This method will auto-generate an ID and create a new organization. If an ID is specified for the organization, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The organization that you would like to be saved.

id
string (ID) /^[\w|-]+$/

The unique, string identifier of this organization

type_id
string (Type)

The organization type

number
required
number <float> (Number)

The contact number

name
required
string (Name)

The name of the organization

acronym
string (Acronym)

The acronym for the organization, if applicable

date_profile_last_updated
string <date-time> (Date Profile Last Updated)

The date that this organization profile was last updated

website
string (Website)

The url of the organization website

domain_name
string (Domain Name)
alternate_domain_names
Array of strings (Alternate Domain Names)

Alternate domain names that are associated with this organization

description
string (Description)

A description of the organization

object (Address)

A complete address

object (Address)

A complete address

Array of objects
main_phone_number
string (Main Phone Number)

The primary phone number

fax_phone_number
string (Fax Phone Number)

The fax phone number

alt_phone_number
string (Alt Phone Number)

The alternative phone number

Array of objects
ancestor_organization_ids
Array of strings (Ancestor Organizations) >= 0 items

The ancestor organizations, including the parent organization

number_of_ancestors
number <float> (Number Of Ancestors)

The number of ancestors this organization has

top_level_organization_id
string (Top Level Organization)

The top level organization; which is the last entry in the ancestor_organization_ids array

parent_organization_id
string (Parent Organization)

The parent organization of this one

notes
string (Notes)

Any organization notes

logo_url
string (Logo Url)

Url of a logo for this organization

flags
Array of strings (Flags)

Flags that indicate what type of organization this is

status
string (Status)

The status of the organization record

Enum: "active" "duplicate" "inactive"
tax_exempt
boolean (Tax Exempt)

Whether or not this organization is tax exempt

contact_role_compliance_status
string (Contact Role Compliance Status)
Enum: "in compliance" "not in compliance"
required
Array of objects non-empty
facebook
string (Facebook)

Url to the organization's Facebook account

twitter
string (Twitter)

Url to the organization's Twitter account

linked_in
string (LinkedIn)

Url to the organization's LinkedIn account

Array of objects (Custom Field Values)
sys_search_city
string (Sys Search City)

Search field, internal use only

sys_search_state
string (Sys Search State)

Search field, internal use only

sys_search_city_lower
string (Sys Search City Lower)

Search field, internal use only

sys_search_state_lower
string (Sys Search State Lower)

Search field, internal use only

sys_search_name
string (Sys Search Name)

Search field, internal use only

sys_search_domain_name
string (Sys Search Domain Name)

Search field, internal use only

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The organization was saved successfully.
400The organization you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The organization could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add organization based on tenant limits.
500General server error.
post/organizations/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a organization from the system by its ID.

This method will look up a organization by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the organization to return.

query Parameters
fields
string

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

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The organization was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The organization could not be found.
429Limit exceeded... unable to retrieve organization based on tenant limits.
500General server error.
get/organizations/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a organization with the specified ID.

This method will update an existing organization with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the organization to update.

Request Body schema: application/json

The updated organization that will be saved.

id
string (ID) /^[\w|-]+$/

The unique, string identifier of this organization

type_id
string (Type)

The organization type

number
required
number <float> (Number)

The contact number

name
required
string (Name)

The name of the organization

acronym
string (Acronym)

The acronym for the organization, if applicable

date_profile_last_updated
string <date-time> (Date Profile Last Updated)

The date that this organization profile was last updated

website
string (Website)

The url of the organization website

domain_name
string (Domain Name)
alternate_domain_names
Array of strings (Alternate Domain Names)

Alternate domain names that are associated with this organization

description
string (Description)

A description of the organization

object (Address)

A complete address

object (Address)

A complete address

Array of objects
main_phone_number
string (Main Phone Number)

The primary phone number

fax_phone_number
string (Fax Phone Number)

The fax phone number

alt_phone_number
string (Alt Phone Number)

The alternative phone number

Array of objects
ancestor_organization_ids
Array of strings (Ancestor Organizations) >= 0 items

The ancestor organizations, including the parent organization

number_of_ancestors
number <float> (Number Of Ancestors)

The number of ancestors this organization has

top_level_organization_id
string (Top Level Organization)

The top level organization; which is the last entry in the ancestor_organization_ids array

parent_organization_id
string (Parent Organization)

The parent organization of this one

notes
string (Notes)

Any organization notes

logo_url
string (Logo Url)

Url of a logo for this organization

flags
Array of strings (Flags)

Flags that indicate what type of organization this is

status
string (Status)

The status of the organization record

Enum: "active" "duplicate" "inactive"
tax_exempt
boolean (Tax Exempt)

Whether or not this organization is tax exempt

contact_role_compliance_status
string (Contact Role Compliance Status)
Enum: "in compliance" "not in compliance"
required
Array of objects non-empty
facebook
string (Facebook)

Url to the organization's Facebook account

twitter
string (Twitter)

Url to the organization's Twitter account

linked_in
string (LinkedIn)

Url to the organization's LinkedIn account

Array of objects (Custom Field Values)
sys_search_city
string (Sys Search City)

Search field, internal use only

sys_search_state
string (Sys Search State)

Search field, internal use only

sys_search_city_lower
string (Sys Search City Lower)

Search field, internal use only

sys_search_state_lower
string (Sys Search State Lower)

Search field, internal use only

sys_search_name
string (Sys Search Name)

Search field, internal use only

sys_search_domain_name
string (Sys Search Domain Name)

Search field, internal use only

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The organization was updated successfully.
400The organization supplied was not valid.
401Unauthorized.
403Forbidden.
404The organization could not be found.
409The organization could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve organization based on tenant limits.
500General server error.
put/organizations/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a organization with the specified ID.

This method will patch an existing organization with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the organization to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The organization was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The organization could not be found.
409The organization could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve organization based on tenant limits.
500General server error.
patch/organizations/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a organization from the system by its ID.

This method will delete a organization with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the organization to delete.

Responses
200The organization was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The organization could not be found.
409The organization could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete organization based on tenant limits.
500General server error.
delete/organizations/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Searches for organizations using predefined parameters

Searches for organizations using predefined parameters

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

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

Request Body schema: application/json

The organization that you would like to be saved.

ids
Array of strings (Ids)

IDs to search

status
Array of strings (Status)
name
string (Name)

The name

type_id
string (Type)
number
Array of numbers <float> (Number)
domain_name
string (Domain Name)

The domain name

city
string (City)

City to search

state
string (State)

The state

Responses
200The organization search was saved successfully.
400The organization you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The organization could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add organization based on tenant limits.
500General server error.
post/organizations/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "ids": [
    ],
  • "status": [
    ],
  • "name": "string",
  • "type_id": "string",
  • "number": [
    ],
  • "domain_name": "string",
  • "city": "string",
  • "state": "string"
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Finds all conflicting fields for organizations

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

ids
required
string

Comma-separated listo fIDS

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
get/organizations/{tenantId}/getFieldConflicts/{ids}
Request samples
curl -i -X GET \
  https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/getFieldConflicts/:ids \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "conflicting_fields": [
    ],
  • "contacts": [
    ],
  • "organizations": [
    ]
}

Get all descendent organizations

Recursively finds all descendents to an organization

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The organization ID

query Parameters
fields
string

The fields

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
get/organizations/{tenantId}/descendents/{id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/descendents/:id?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns the organization matching the specified domain_name

Returns the organization matching the specified domain_name

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

domain_name
required
string

The domain_name to use to for record lookup

query Parameters
fields
string

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

Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/organizations/{tenantId}/domain_name/{domain_name}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/domain_name/:domain_name?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

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

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

domain
required
string

The domain to look up

Responses
200The social profile was retrieved successfully
400The request was not valid
401Unauthorized
403Forbidden
404The social profile was not found
429Limit exceeded... unable to retrieve counts based on tenant limits.
500General server error
get/organizations/{tenantId}/socialProfile/{domain}
Request samples
curl -i -X GET \
  https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/socialProfile/:domain \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "employees": 0,
  • "founded": 0,
  • "category": "string",
  • "location": "string",
  • "logo": "string",
  • "name": "string",
  • "locale": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "linkedin": "string",
  • "bio": "string",
  • "details": {
    }
}

Updates a organization with data merged from other organizations then signals other microservices to complete the merge

Updates a organization with data merged from other organizations then signals other microservices to complete the merge

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the organization to merge.

Request Body schema: application/json

The updated organization to be merged.

source_ids
required
Array of strings (Sources) non-empty

The source IDs to merge

object (Options)
Responses
200The organization was merged successfully.
400The organization supplied was not valid.
401Unauthorized
403Forbidden
404The organization could not be found.
409The organization could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to merge organization based on tenant limits.
500General server error.
put/organizations/{tenantId}/{id}/merge
Request samples
    1 more
    Python
application/json
{
  • "source_ids": [
    ],
  • "options": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "type_id": "string",
  • "number": 0,
  • "name": "string",
  • "acronym": "string",
  • "date_profile_last_updated": "2019-08-24T14:15:22Z",
  • "website": "string",
  • "domain_name": "string",
  • "alternate_domain_names": [
    ],
  • "description": "string",
  • "address": {
    },
  • "billing_address": {
    },
  • "other_addresses": [
    ],
  • "main_phone_number": "string",
  • "fax_phone_number": "string",
  • "alt_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "ancestor_organization_ids": [
    ],
  • "number_of_ancestors": 0,
  • "top_level_organization_id": "string",
  • "parent_organization_id": "string",
  • "notes": "string",
  • "logo_url": "string",
  • "flags": [
    ],
  • "status": "active",
  • "tax_exempt": true,
  • "contact_role_compliance_status": "in compliance",
  • "contact_role_compliance_violations": [
    ],
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "custom_field_values": [
    ],
  • "sys_search_city": "string",
  • "sys_search_state": "string",
  • "sys_search_city_lower": "string",
  • "sys_search_state_lower": "string",
  • "sys_search_name": "string",
  • "sys_search_domain_name": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a list of records with the specified parent_organization_id

Returns a list of records with the specified parent_organization_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

parent_organization_id
required
string

The parent_organization_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/organizations/{tenantId}/parentOrganization/{parent_organization_id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/parentOrganization/:parent_organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Re-runs compliance for all organizations in the system

Given a set of expiration options, allows for the calculation of an expiration date

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Responses
200Date was calculated successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
post/organizations/{tenantId}/reprocessCompliance
Request samples
curl -i -X POST \
  https://rolodex.api.756794052567.rhythmsoftware.com/organizations/:tenantId/reprocessCompliance \
  -H 'Authorization: YOUR_API_KEY_HERE'

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

contact_id
required
string (Contact)
organization_id
required
string (Organization)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/organizations/{tenantId}/previewContactRoleComplianceEmail
Request samples
    1 more
    Python
application/json
{
  • "contact_id": "string",
  • "organization_id": "string",
  • "email_template": {
    },
  • "destination_email_address": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The organization could not be found.
429Limit exceeded... unable to retrieve organization based on tenant limits.
500General server error.
post/organizations/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}