Powered by Redocly

Organization

The endpoint for the information on your Quorum instance.

Retrieve information on Organizations visible to your account.

get/organization/

Organizations exist at the top level of the userdata hierarchy, representing the entity that provides your Quorum subscription. For example, an employee at Foo Conglomerate would be part of the Foo organization.

Filterable fields:
admin_id
archived
cs_managers
email_limit
id
max_members
name
onboarding_type
partners
updated

Securityapi_key and username
Request
query Parameters
archived
boolean
cs_managers
Array of integers <int64>

The quorumusers that are associated with this organization.

NOTE: Parameter accepts additional qualifiers appended to the end:
cs_managers__overlaps - The value for the record has one or more values in common with the provided array parameter (comma-separated values).

email_limit
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
email_limit__in - The value for the record is in the provided array parameter (comma-separated values).
email_limit__gt, email_limit__gte, email_limit__lt, email_limit__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
email_limit__isnull - The value for the record is null (if true) or is not null.

id
integer <int64>

Quorum ID (Primary Key)

max_members
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
max_members__in - The value for the record is in the provided array parameter (comma-separated values).
max_members__gt, max_members__gte, max_members__lt, max_members__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
max_members__isnull - The value for the record is null (if true) or is not null.

name
string

NOTE: Parameter accepts additional qualifiers appended to the end:
name__in - The value for the record is in the provided array parameter (comma-separated values).
name__contains, name__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
name__startswith, name__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
name__endswith, name__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
name__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

onboarding_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
onboarding_type__in - The value for the record is in the provided array parameter (comma-separated values).

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name OnboardingType, for an explanation of values.

Enum: 1 2 3 4 5 6
partners
Array of integers <int64>

The organizations that are associated with this organization.

NOTE: Parameter accepts additional qualifiers appended to the end:
partners__overlaps - The value for the record has one or more values in common with the provided array parameter (comma-separated values).

updated
string <date-time>

NOTE: Parameter accepts additional qualifiers appended to the end:
updated__year, updated__month, updated__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

dehydrate
Array of strings

Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.
resource_uri - expand resource_uri with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "resource_uri"
limit
integer <int64>
Default: 20

The number of records to return (for pagination).

offset
integer <int64>
Default: 0

The number of records to offset the start of the data being returned (for pagination).

Responses
200

Organization retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "account_type": 1,
  • "active_client": false,
  • "admin_can_create_custom_official": false,
  • "admin_can_log_in_as_user": false,
  • "administrators": [
    ],
  • "agreed_to_texting_user": "/api/user/1/",
  • "allowed_domains": [
    ],
  • "allowed_user_domains": [
    ],
  • "archived": false,
  • "auto_enrich_supporters": false,
  • "can_see_partners_users": false,
  • "can_use_independent_campaigns": false,
  • "created": "2019-08-24T14:15:22Z",
  • "cs_managers": [
    ],
  • "cs_managers_usernames": "string",
  • "custom_alert_orderings": { },
  • "custom_event_json": { },
  • "custom_session_timeout": 0,
  • "date_archived": "2019-08-24T14:15:22Z",
  • "datetime_agreed_to_texting": "2019-08-24T14:15:22Z",
  • "default_domain": "string",
  • "default_forward_recipient": "/api/user/1/",
  • "default_unsubscribe_setting": 1,
  • "deliver_supporter_messages": true,
  • "disable_action_center_magic_link": false,
  • "email_limit": 31250,
  • "email_limit_percentage": 0,
  • "i360_organization": false,
  • "i360_organization_and_quorum_client": false,
  • "id": 0,
  • "inbound_sms_webhook_url": "string",
  • "internal_interaction_types": [
    ],
  • "internal_relationship_types": [
    ],
  • "ip_addresses": [
    ],
  • "is_approved": false,
  • "limit_to_cs_managers": false,
  • "log_interaction_json": { },
  • "lower_tier_bound": 5,
  • "max_contacts": 0,
  • "max_csv_size": 1000,
  • "max_email_alerts": 0,
  • "max_members": 0,
  • "max_projects": 0,
  • "max_social_accounts": 0,
  • "name": "string",
  • "oauth_profiles": "1/",
  • "onboarding_type": 1,
  • "outbox_domain_dict": { },
  • "p2a_organization_ids": { },
  • "pac_hybrid_autocreate_supporters_from_individuals": false,
  • "pacc_companyid": 0,
  • "pacc_companyloginname": "string",
  • "pacc_source_schema": "CUSTVocusGR",
  • "pad_unique_identifier": false,
  • "partner_names": [
    ],
  • "partners": [
    ],
  • "persona_dashboards": { },
  • "phone_numbers": "/api/phonenumber/1/",
  • "qp_action_center": false,
  • "qp_action_center_campaigns": true,
  • "qp_ai_board_tracker": false,
  • "qp_ai_grassroots_messages": true,
  • "qp_ai_notes": true,
  • "qp_ai_outbox_suggestions": true,
  • "qp_ai_personalized_summaries": false,
  • "qp_ai_profile_management": false,
  • "qp_ai_summaries": true,
  • "qp_ai_tracking_boards": true,
  • "qp_brief_builder": true,
  • "qp_campaign_finance": false,
  • "qp_can_access_candidate_data": false,
  • "qp_collaborators": false,
  • "qp_consultants": false,
  • "qp_contacts_documents": false,
  • "qp_copilot_analyze": true,
  • "qp_copilot_grassroots": false,
  • "qp_copilot_pac": false,
  • "qp_custom_contacts": false,
  • "qp_custom_data": false,
  • "qp_custom_docket": false,
  • "qp_custom_events": false,
  • "qp_custom_outbox": false,
  • "qp_custom_permissions": false,
  • "qp_custom_sms_api": false,
  • "qp_download_center": false,
  • "qp_eu": false,
  • "qp_executives": [
    ],
  • "qp_external_interactions": false,
  • "qp_external_relationship": false,
  • "qp_federal": false,
  • "qp_gotv_supporter_anonymization": false,
  • "qp_grassroots": [
    ],
  • "qp_hide_alignment": false,
  • "qp_hide_assignment": false,
  • "qp_hide_priority": false,
  • "qp_hide_review_status": false,
  • "qp_hide_stance": false,
  • "qp_internal_relationship": false,
  • "qp_international": [
    ],
  • "qp_legislation_page": false,
  • "qp_legislative_data": [
    ],
  • "qp_legislative_profiles": [
    ],
  • "qp_legislators": [
    ],
  • "qp_live_chat": false,
  • "qp_local": [
    ],
  • "qp_local_agendas": false,
  • "qp_media_monitoring": [
    ],
  • "qp_media_relations": [
    ],
  • "qp_official_documents": [
    ],
  • "qp_officials_outbox": false,
  • "qp_pac_allow_duplicate_supporter_emails": false,
  • "qp_pac_hybrid": false,
  • "qp_pac_hybrid_or_qpac_v1": true,
  • "qp_pac_match": false,
  • "qp_pac_state_and_local_committees": false,
  • "qp_pac_supporter_auto_eligibility": false,
  • "qp_pac_sync_supporter_from_pacc": false,
  • "qp_project_management": false,
  • "qp_qpac_v1": false,
  • "qp_regulations": [
    ],
  • "qp_school_boards": [
    ],
  • "qp_staffers": [
    ],
  • "qp_stakeholder": false,
  • "qp_states": [
    ],
  • "qp_unique_ids_in_downloads": true,
  • "require_issue_on_interaction": false,
  • "require_issue_on_outbox": false,
  • "resource_uri": "string",
  • "share_all_custom_regions": false,
  • "should_display_grassroots_registration_actions": false,
  • "should_limit_editing_notes_to_admins_and_creators": false,
  • "should_org_admin_see_all_org_data": false,
  • "should_share_with_partners_by_default": false,
  • "should_show_only_users_on_teams": false,
  • "sms_additional_credits": 0,
  • "sms_additional_credits_usage": 0,
  • "sms_limit": 0,
  • "sms_messages_toward_limit": 0,
  • "sms_renew_cycle": 0,
  • "sms_renew_date": "2019-08-24T14:15:22Z",
  • "sms_renew_type": 0,
  • "sso_enabled_for_all_users": false,
  • "sso_profiles": "/api/ssoprofile/1/",
  • "subdomain": "string",
  • "texting_contact_info": "string",
  • "texting_message_frequency": 0,
  • "texting_org_name": "string",
  • "texting_privacy_url": "string",
  • "texting_terms_url": "string",
  • "trial_expiration": "2019-08-24T14:15:22Z",
  • "unsubscribe_link_text": "",
  • "updated": "2019-08-24T14:15:22Z",
  • "upper_tier_bound": 5,
  • "zapier_token": "string"
}

Retrieve information on a single Organization

get/organization/{id}/

Organizations exist at the top level of the userdata hierarchy, representing the entity that provides your Quorum subscription. For example, an employee at Foo Conglomerate would be part of the Foo organization.

Securityapi_key and username
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

query Parameters
dehydrate
Array of strings

Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.
resource_uri - expand resource_uri with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "resource_uri"
Responses
200

Organization retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "account_type": 1,
  • "active_client": false,
  • "admin_can_create_custom_official": false,
  • "admin_can_log_in_as_user": false,
  • "administrators": [
    ],
  • "agreed_to_texting_user": "/api/user/1/",
  • "allowed_domains": [
    ],
  • "allowed_user_domains": [
    ],
  • "archived": false,
  • "auto_enrich_supporters": false,
  • "can_see_partners_users": false,
  • "can_use_independent_campaigns": false,
  • "created": "2019-08-24T14:15:22Z",
  • "cs_managers": [
    ],
  • "cs_managers_usernames": "string",
  • "custom_alert_orderings": { },
  • "custom_event_json": { },
  • "custom_session_timeout": 0,
  • "date_archived": "2019-08-24T14:15:22Z",
  • "datetime_agreed_to_texting": "2019-08-24T14:15:22Z",
  • "default_domain": "string",
  • "default_forward_recipient": "/api/user/1/",
  • "default_unsubscribe_setting": 1,
  • "deliver_supporter_messages": true,
  • "disable_action_center_magic_link": false,
  • "email_limit": 31250,
  • "email_limit_percentage": 0,
  • "i360_organization": false,
  • "i360_organization_and_quorum_client": false,
  • "id": 0,
  • "inbound_sms_webhook_url": "string",
  • "internal_interaction_types": [
    ],
  • "internal_relationship_types": [
    ],
  • "ip_addresses": [
    ],
  • "is_approved": false,
  • "limit_to_cs_managers": false,
  • "log_interaction_json": { },
  • "lower_tier_bound": 5,
  • "max_contacts": 0,
  • "max_csv_size": 1000,
  • "max_email_alerts": 0,
  • "max_members": 0,
  • "max_projects": 0,
  • "max_social_accounts": 0,
  • "name": "string",
  • "oauth_profiles": "1/",
  • "onboarding_type": 1,
  • "outbox_domain_dict": { },
  • "p2a_organization_ids": { },
  • "pac_hybrid_autocreate_supporters_from_individuals": false,
  • "pacc_companyid": 0,
  • "pacc_companyloginname": "string",
  • "pacc_source_schema": "CUSTVocusGR",
  • "pad_unique_identifier": false,
  • "partner_names": [
    ],
  • "partners": [
    ],
  • "persona_dashboards": { },
  • "phone_numbers": "/api/phonenumber/1/",
  • "qp_action_center": false,
  • "qp_action_center_campaigns": true,
  • "qp_ai_board_tracker": false,
  • "qp_ai_grassroots_messages": true,
  • "qp_ai_notes": true,
  • "qp_ai_outbox_suggestions": true,
  • "qp_ai_personalized_summaries": false,
  • "qp_ai_profile_management": false,
  • "qp_ai_summaries": true,
  • "qp_ai_tracking_boards": true,
  • "qp_brief_builder": true,
  • "qp_campaign_finance": false,
  • "qp_can_access_candidate_data": false,
  • "qp_collaborators": false,
  • "qp_consultants": false,
  • "qp_contacts_documents": false,
  • "qp_copilot_analyze": true,
  • "qp_copilot_grassroots": false,
  • "qp_copilot_pac": false,
  • "qp_custom_contacts": false,
  • "qp_custom_data": false,
  • "qp_custom_docket": false,
  • "qp_custom_events": false,
  • "qp_custom_outbox": false,
  • "qp_custom_permissions": false,
  • "qp_custom_sms_api": false,
  • "qp_download_center": false,
  • "qp_eu": false,
  • "qp_executives": [
    ],
  • "qp_external_interactions": false,
  • "qp_external_relationship": false,
  • "qp_federal": false,
  • "qp_gotv_supporter_anonymization": false,
  • "qp_grassroots": [
    ],
  • "qp_hide_alignment": false,
  • "qp_hide_assignment": false,
  • "qp_hide_priority": false,
  • "qp_hide_review_status": false,
  • "qp_hide_stance": false,
  • "qp_internal_relationship": false,
  • "qp_international": [
    ],
  • "qp_legislation_page": false,
  • "qp_legislative_data": [
    ],
  • "qp_legislative_profiles": [
    ],
  • "qp_legislators": [
    ],
  • "qp_live_chat": false,
  • "qp_local": [
    ],
  • "qp_local_agendas": false,
  • "qp_media_monitoring": [
    ],
  • "qp_media_relations": [
    ],
  • "qp_official_documents": [
    ],
  • "qp_officials_outbox": false,
  • "qp_pac_allow_duplicate_supporter_emails": false,
  • "qp_pac_hybrid": false,
  • "qp_pac_hybrid_or_qpac_v1": true,
  • "qp_pac_match": false,
  • "qp_pac_state_and_local_committees": false,
  • "qp_pac_supporter_auto_eligibility": false,
  • "qp_pac_sync_supporter_from_pacc": false,
  • "qp_project_management": false,
  • "qp_qpac_v1": false,
  • "qp_regulations": [
    ],
  • "qp_school_boards": [
    ],
  • "qp_staffers": [
    ],
  • "qp_stakeholder": false,
  • "qp_states": [
    ],
  • "qp_unique_ids_in_downloads": true,
  • "require_issue_on_interaction": false,
  • "require_issue_on_outbox": false,
  • "resource_uri": "string",
  • "share_all_custom_regions": false,
  • "should_display_grassroots_registration_actions": false,
  • "should_limit_editing_notes_to_admins_and_creators": false,
  • "should_org_admin_see_all_org_data": false,
  • "should_share_with_partners_by_default": false,
  • "should_show_only_users_on_teams": false,
  • "sms_additional_credits": 0,
  • "sms_additional_credits_usage": 0,
  • "sms_limit": 0,
  • "sms_messages_toward_limit": 0,
  • "sms_renew_cycle": 0,
  • "sms_renew_date": "2019-08-24T14:15:22Z",
  • "sms_renew_type": 0,
  • "sso_enabled_for_all_users": false,
  • "sso_profiles": "/api/ssoprofile/1/",
  • "subdomain": "string",
  • "texting_contact_info": "string",
  • "texting_message_frequency": 0,
  • "texting_org_name": "string",
  • "texting_privacy_url": "string",
  • "texting_terms_url": "string",
  • "trial_expiration": "2019-08-24T14:15:22Z",
  • "unsubscribe_link_text": "",
  • "updated": "2019-08-24T14:15:22Z",
  • "upper_tier_bound": 5,
  • "zapier_token": "string"
}

Update a single Organization by ID

patch/organization/{id}/

Organizations exist at the top level of the userdata hierarchy, representing the entity that provides your Quorum subscription. For example, an employee at Foo Conglomerate would be part of the Foo organization.

Securityapi_key and username
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Request Body schema: application/json
object
Responses
200

Organization retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{ }
Response samples
application/json
{
  • "_extra": { },
  • "account_type": 1,
  • "active_client": false,
  • "admin_can_create_custom_official": false,
  • "admin_can_log_in_as_user": false,
  • "administrators": [
    ],
  • "agreed_to_texting_user": "/api/user/1/",
  • "allowed_domains": [
    ],
  • "allowed_user_domains": [
    ],
  • "archived": false,
  • "auto_enrich_supporters": false,
  • "can_see_partners_users": false,
  • "can_use_independent_campaigns": false,
  • "created": "2019-08-24T14:15:22Z",
  • "cs_managers": [
    ],
  • "cs_managers_usernames": "string",
  • "custom_alert_orderings": { },
  • "custom_event_json": { },
  • "custom_session_timeout": 0,
  • "date_archived": "2019-08-24T14:15:22Z",
  • "datetime_agreed_to_texting": "2019-08-24T14:15:22Z",
  • "default_domain": "string",
  • "default_forward_recipient": "/api/user/1/",
  • "default_unsubscribe_setting": 1,
  • "deliver_supporter_messages": true,
  • "disable_action_center_magic_link": false,
  • "email_limit": 31250,
  • "email_limit_percentage": 0,
  • "i360_organization": false,
  • "i360_organization_and_quorum_client": false,
  • "id": 0,
  • "inbound_sms_webhook_url": "string",
  • "internal_interaction_types": [
    ],
  • "internal_relationship_types": [
    ],
  • "ip_addresses": [
    ],
  • "is_approved": false,
  • "limit_to_cs_managers": false,
  • "log_interaction_json": { },
  • "lower_tier_bound": 5,
  • "max_contacts": 0,
  • "max_csv_size": 1000,
  • "max_email_alerts": 0,
  • "max_members": 0,
  • "max_projects": 0,
  • "max_social_accounts": 0,
  • "name": "string",
  • "oauth_profiles": "1/",
  • "onboarding_type": 1,
  • "outbox_domain_dict": { },
  • "p2a_organization_ids": { },
  • "pac_hybrid_autocreate_supporters_from_individuals": false,
  • "pacc_companyid": 0,
  • "pacc_companyloginname": "string",
  • "pacc_source_schema": "CUSTVocusGR",
  • "pad_unique_identifier": false,
  • "partner_names": [
    ],
  • "partners": [
    ],
  • "persona_dashboards": { },
  • "phone_numbers": "/api/phonenumber/1/",
  • "qp_action_center": false,
  • "qp_action_center_campaigns": true,
  • "qp_ai_board_tracker": false,
  • "qp_ai_grassroots_messages": true,
  • "qp_ai_notes": true,
  • "qp_ai_outbox_suggestions": true,
  • "qp_ai_personalized_summaries": false,
  • "qp_ai_profile_management": false,
  • "qp_ai_summaries": true,
  • "qp_ai_tracking_boards": true,
  • "qp_brief_builder": true,
  • "qp_campaign_finance": false,
  • "qp_can_access_candidate_data": false,
  • "qp_collaborators": false,
  • "qp_consultants": false,
  • "qp_contacts_documents": false,
  • "qp_copilot_analyze": true,
  • "qp_copilot_grassroots": false,
  • "qp_copilot_pac": false,
  • "qp_custom_contacts": false,
  • "qp_custom_data": false,
  • "qp_custom_docket": false,
  • "qp_custom_events": false,
  • "qp_custom_outbox": false,
  • "qp_custom_permissions": false,
  • "qp_custom_sms_api": false,
  • "qp_download_center": false,
  • "qp_eu": false,
  • "qp_executives": [
    ],
  • "qp_external_interactions": false,
  • "qp_external_relationship": false,
  • "qp_federal": false,
  • "qp_gotv_supporter_anonymization": false,
  • "qp_grassroots": [
    ],
  • "qp_hide_alignment": false,
  • "qp_hide_assignment": false,
  • "qp_hide_priority": false,
  • "qp_hide_review_status": false,
  • "qp_hide_stance": false,
  • "qp_internal_relationship": false,
  • "qp_international": [
    ],
  • "qp_legislation_page": false,
  • "qp_legislative_data": [
    ],
  • "qp_legislative_profiles": [
    ],
  • "qp_legislators": [
    ],
  • "qp_live_chat": false,
  • "qp_local": [
    ],
  • "qp_local_agendas": false,
  • "qp_media_monitoring": [
    ],
  • "qp_media_relations": [
    ],
  • "qp_official_documents": [
    ],
  • "qp_officials_outbox": false,
  • "qp_pac_allow_duplicate_supporter_emails": false,
  • "qp_pac_hybrid": false,
  • "qp_pac_hybrid_or_qpac_v1": true,
  • "qp_pac_match": false,
  • "qp_pac_state_and_local_committees": false,
  • "qp_pac_supporter_auto_eligibility": false,
  • "qp_pac_sync_supporter_from_pacc": false,
  • "qp_project_management": false,
  • "qp_qpac_v1": false,
  • "qp_regulations": [
    ],
  • "qp_school_boards": [
    ],
  • "qp_staffers": [
    ],
  • "qp_stakeholder": false,
  • "qp_states": [
    ],
  • "qp_unique_ids_in_downloads": true,
  • "require_issue_on_interaction": false,
  • "require_issue_on_outbox": false,
  • "resource_uri": "string",
  • "share_all_custom_regions": false,
  • "should_display_grassroots_registration_actions": false,
  • "should_limit_editing_notes_to_admins_and_creators": false,
  • "should_org_admin_see_all_org_data": false,
  • "should_share_with_partners_by_default": false,
  • "should_show_only_users_on_teams": false,
  • "sms_additional_credits": 0,
  • "sms_additional_credits_usage": 0,
  • "sms_limit": 0,
  • "sms_messages_toward_limit": 0,
  • "sms_renew_cycle": 0,
  • "sms_renew_date": "2019-08-24T14:15:22Z",
  • "sms_renew_type": 0,
  • "sso_enabled_for_all_users": false,
  • "sso_profiles": "/api/ssoprofile/1/",
  • "subdomain": "string",
  • "texting_contact_info": "string",
  • "texting_message_frequency": 0,
  • "texting_org_name": "string",
  • "texting_privacy_url": "string",
  • "texting_terms_url": "string",
  • "trial_expiration": "2019-08-24T14:15:22Z",
  • "unsubscribe_link_text": "",
  • "updated": "2019-08-24T14:15:22Z",
  • "upper_tier_bound": 5,
  • "zapier_token": "string"
}
➔ Next to Quorum Users