Powered by Redocly

Organization

The endpoint for the information on your Quorum instance.

Retrieve information on Organizations visible to your account.

get/api/organization/

The endpoint for the information on your Quorum instance.

Securityapi_key and user_name
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.

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).

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": true,
  • "administrators": null,
  • "agreed_to_texting_user": "/api/user/1/",
  • "allowed_domains": [
    ],
  • "allowed_user_domains": [
    ],
  • "archived": true,
  • "auto_enrich_supporters": true,
  • "can_see_partners_users": true,
  • "can_use_independent_campaigns": true,
  • "created": "2019-08-24T14:15:22Z",
  • "cs_managers": [
    ],
  • "cs_managers_usernames": "string",
  • "custom_alert_orderings": { },
  • "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/",
  • "deliver_supporter_messages": true,
  • "email_limit": 0,
  • "email_limit_percentage": 0,
  • "i360_organization": true,
  • "i360_organization_and_quorum_client": true,
  • "id": 0,
  • "internal_interaction_types": [
    ],
  • "internal_relationship_types": [
    ],
  • "ip_addresses": [
    ],
  • "is_approved": true,
  • "limit_to_cs_managers": true,
  • "lower_tier_bound": 0,
  • "max_contacts": 0,
  • "max_csv_size": 0,
  • "max_email_alerts": 0,
  • "max_members": 0,
  • "max_projects": 0,
  • "max_social_accounts": 0,
  • "name": "string",
  • "outbox_domain_dict": { },
  • "pad_unique_identifier": true,
  • "partner_names": null,
  • "partners": [
    ],
  • "phone_numbers": "/api/phonenumber/1/",
  • "qp_action_center": true,
  • "qp_consultants": true,
  • "qp_contacts_documents": true,
  • "qp_custom_contacts": true,
  • "qp_custom_data": true,
  • "qp_custom_events": true,
  • "qp_custom_outbox": true,
  • "qp_custom_permissions": true,
  • "qp_eu": true,
  • "qp_executives": [
    ],
  • "qp_external_interactions": true,
  • "qp_external_relationship": true,
  • "qp_federal": true,
  • "qp_grassroots": [
    ],
  • "qp_internal_relationship": true,
  • "qp_international": [
    ],
  • "qp_legislation_page": true,
  • "qp_legislative_data": [
    ],
  • "qp_legislative_profiles": [
    ],
  • "qp_legislators": [
    ],
  • "qp_live_chat": true,
  • "qp_local": [
    ],
  • "qp_local_agendas": true,
  • "qp_media_monitoring": [
    ],
  • "qp_media_relations": [
    ],
  • "qp_official_documents": [
    ],
  • "qp_officials_outbox": true,
  • "qp_pac": true,
  • "qp_project_management": true,
  • "qp_regulations": [
    ],
  • "qp_staffers": [
    ],
  • "qp_stakeholder": true,
  • "qp_states": [
    ],
  • "qp_unique_ids_in_downloads": true,
  • "require_issue_on_interaction": true,
  • "require_issue_on_outbox": true,
  • "resource_uri": "string",
  • "share_all_custom_regions": true,
  • "should_display_grassroots_registration_actions": true,
  • "should_limit_editing_notes_to_admins_and_creators": true,
  • "should_org_admin_see_all_org_data": true,
  • "should_share_with_partners_by_default": true,
  • "should_show_only_users_on_teams": true,
  • "sms_limit": 0,
  • "sms_messages_toward_limit": 0,
  • "sso_enabled_for_all_users": true,
  • "sso_profiles": "/api/ssoprofile/1/",
  • "subdomain": "string",
  • "trial_expiration": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "upper_tier_bound": 0,
  • "zapier_token": "string"
}

Retrieve information on a single Organization

get/api/organization/{id}/

The endpoint for the information on your Quorum instance.

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

Quorum ID (Primary Key)

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": true,
  • "administrators": null,
  • "agreed_to_texting_user": "/api/user/1/",
  • "allowed_domains": [
    ],
  • "allowed_user_domains": [
    ],
  • "archived": true,
  • "auto_enrich_supporters": true,
  • "can_see_partners_users": true,
  • "can_use_independent_campaigns": true,
  • "created": "2019-08-24T14:15:22Z",
  • "cs_managers": [
    ],
  • "cs_managers_usernames": "string",
  • "custom_alert_orderings": { },
  • "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/",
  • "deliver_supporter_messages": true,
  • "email_limit": 0,
  • "email_limit_percentage": 0,
  • "i360_organization": true,
  • "i360_organization_and_quorum_client": true,
  • "id": 0,
  • "internal_interaction_types": [
    ],
  • "internal_relationship_types": [
    ],
  • "ip_addresses": [
    ],
  • "is_approved": true,
  • "limit_to_cs_managers": true,
  • "lower_tier_bound": 0,
  • "max_contacts": 0,
  • "max_csv_size": 0,
  • "max_email_alerts": 0,
  • "max_members": 0,
  • "max_projects": 0,
  • "max_social_accounts": 0,
  • "name": "string",
  • "outbox_domain_dict": { },
  • "pad_unique_identifier": true,
  • "partner_names": null,
  • "partners": [
    ],
  • "phone_numbers": "/api/phonenumber/1/",
  • "qp_action_center": true,
  • "qp_consultants": true,
  • "qp_contacts_documents": true,
  • "qp_custom_contacts": true,
  • "qp_custom_data": true,
  • "qp_custom_events": true,
  • "qp_custom_outbox": true,
  • "qp_custom_permissions": true,
  • "qp_eu": true,
  • "qp_executives": [
    ],
  • "qp_external_interactions": true,
  • "qp_external_relationship": true,
  • "qp_federal": true,
  • "qp_grassroots": [
    ],
  • "qp_internal_relationship": true,
  • "qp_international": [
    ],
  • "qp_legislation_page": true,
  • "qp_legislative_data": [
    ],
  • "qp_legislative_profiles": [
    ],
  • "qp_legislators": [
    ],
  • "qp_live_chat": true,
  • "qp_local": [
    ],
  • "qp_local_agendas": true,
  • "qp_media_monitoring": [
    ],
  • "qp_media_relations": [
    ],
  • "qp_official_documents": [
    ],
  • "qp_officials_outbox": true,
  • "qp_pac": true,
  • "qp_project_management": true,
  • "qp_regulations": [
    ],
  • "qp_staffers": [
    ],
  • "qp_stakeholder": true,
  • "qp_states": [
    ],
  • "qp_unique_ids_in_downloads": true,
  • "require_issue_on_interaction": true,
  • "require_issue_on_outbox": true,
  • "resource_uri": "string",
  • "share_all_custom_regions": true,
  • "should_display_grassroots_registration_actions": true,
  • "should_limit_editing_notes_to_admins_and_creators": true,
  • "should_org_admin_see_all_org_data": true,
  • "should_share_with_partners_by_default": true,
  • "should_show_only_users_on_teams": true,
  • "sms_limit": 0,
  • "sms_messages_toward_limit": 0,
  • "sso_enabled_for_all_users": true,
  • "sso_profiles": "/api/ssoprofile/1/",
  • "subdomain": "string",
  • "trial_expiration": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "upper_tier_bound": 0,
  • "zapier_token": "string"
}

Update a single Organization by ID

patch/api/organization/{id}/

The endpoint for the information on your Quorum instance.

Securityapi_key and user_name
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": true,
  • "administrators": null,
  • "agreed_to_texting_user": "/api/user/1/",
  • "allowed_domains": [
    ],
  • "allowed_user_domains": [
    ],
  • "archived": true,
  • "auto_enrich_supporters": true,
  • "can_see_partners_users": true,
  • "can_use_independent_campaigns": true,
  • "created": "2019-08-24T14:15:22Z",
  • "cs_managers": [
    ],
  • "cs_managers_usernames": "string",
  • "custom_alert_orderings": { },
  • "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/",
  • "deliver_supporter_messages": true,
  • "email_limit": 0,
  • "email_limit_percentage": 0,
  • "i360_organization": true,
  • "i360_organization_and_quorum_client": true,
  • "id": 0,
  • "internal_interaction_types": [
    ],
  • "internal_relationship_types": [
    ],
  • "ip_addresses": [
    ],
  • "is_approved": true,
  • "limit_to_cs_managers": true,
  • "lower_tier_bound": 0,
  • "max_contacts": 0,
  • "max_csv_size": 0,
  • "max_email_alerts": 0,
  • "max_members": 0,
  • "max_projects": 0,
  • "max_social_accounts": 0,
  • "name": "string",
  • "outbox_domain_dict": { },
  • "pad_unique_identifier": true,
  • "partner_names": null,
  • "partners": [
    ],
  • "phone_numbers": "/api/phonenumber/1/",
  • "qp_action_center": true,
  • "qp_consultants": true,
  • "qp_contacts_documents": true,
  • "qp_custom_contacts": true,
  • "qp_custom_data": true,
  • "qp_custom_events": true,
  • "qp_custom_outbox": true,
  • "qp_custom_permissions": true,
  • "qp_eu": true,
  • "qp_executives": [
    ],
  • "qp_external_interactions": true,
  • "qp_external_relationship": true,
  • "qp_federal": true,
  • "qp_grassroots": [
    ],
  • "qp_internal_relationship": true,
  • "qp_international": [
    ],
  • "qp_legislation_page": true,
  • "qp_legislative_data": [
    ],
  • "qp_legislative_profiles": [
    ],
  • "qp_legislators": [
    ],
  • "qp_live_chat": true,
  • "qp_local": [
    ],
  • "qp_local_agendas": true,
  • "qp_media_monitoring": [
    ],
  • "qp_media_relations": [
    ],
  • "qp_official_documents": [
    ],
  • "qp_officials_outbox": true,
  • "qp_pac": true,
  • "qp_project_management": true,
  • "qp_regulations": [
    ],
  • "qp_staffers": [
    ],
  • "qp_stakeholder": true,
  • "qp_states": [
    ],
  • "qp_unique_ids_in_downloads": true,
  • "require_issue_on_interaction": true,
  • "require_issue_on_outbox": true,
  • "resource_uri": "string",
  • "share_all_custom_regions": true,
  • "should_display_grassroots_registration_actions": true,
  • "should_limit_editing_notes_to_admins_and_creators": true,
  • "should_org_admin_see_all_org_data": true,
  • "should_share_with_partners_by_default": true,
  • "should_show_only_users_on_teams": true,
  • "sms_limit": 0,
  • "sms_messages_toward_limit": 0,
  • "sso_enabled_for_all_users": true,
  • "sso_profiles": "/api/ssoprofile/1/",
  • "subdomain": "string",
  • "trial_expiration": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "upper_tier_bound": 0,
  • "zapier_token": "string"
}
➔ Next to Quorum Users