Powered by Redocly

Notes

The endpoint for the Notes dataset, including all comments, historic interactions, and donations created in your Quorum account.

Retrieve multiple Notes (Historic Interactions / Comments / Donations) based on search critera passed as GET Arguments

get/note/
Securityapi_key and username
Request
query Parameters
amendment_id
integer <int64>

The newamendment with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
amendment__in - The value for the record is in the provided array parameter (comma-separated values).
amendment__isnull - The value for the record is null (if true) or is not null.

amendments
Array of integers <int64>

The newamendments that are associated with this note.

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

amount
number <decimal>

NOTE: Parameter accepts additional qualifiers appended to the end:
amount__in - The value for the record is in the provided array parameter (comma-separated values).
amount__gt, amount__gte, amount__lt, amount__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
amount__isnull - The value for the record is null (if true) or is not null.

archived
boolean
bill_id
integer <int64>

The newbill with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
bill__in - The value for the record is in the provided array parameter (comma-separated values).
bill__isnull - The value for the record is null (if true) or is not null.

bills
Array of integers <int64>

The newbills that are associated with this note.

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

bulk_email_id
integer <int64>

The bulkemail with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
bulk_email__in - The value for the record is in the provided array parameter (comma-separated values).
bulk_email__isnull - The value for the record is null (if true) or is not null.

campaign_id
integer <int64>

The campaign with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
campaign__in - The value for the record is in the provided array parameter (comma-separated values).
campaign__isnull - The value for the record is null (if true) or is not null.

check_number
string

NOTE: Parameter accepts additional qualifiers appended to the end:
check_number__in - The value for the record is in the provided array parameter (comma-separated values).
check_number__contains, check_number__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)
check_number__startswith, check_number__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
check_number__endswith, check_number__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)
check_number__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
check_number__isnull - The value for the record is null (if true) or is not null.

comment_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
comment_type__in - The value for the record is in the provided array parameter (comma-separated values).
comment_type__isnull - The value for the record is null (if true) or is not null.

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

Enum: 1 2 3 4 5 6 7 8 9 10 12 14 15 16 17 18 20 21 22 23 24 25 26 27 28 29 30 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 52 53 54 55 56 57 58 59 60 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
created
string <date-time>

NOTE: Parameter accepts additional qualifiers appended to the end:
created__year, created__month, created__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).

custom_interaction_type_id
integer <int64>

The custominteractiontype with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
custom_interaction_type__in - The value for the record is in the provided array parameter (comma-separated values).
custom_interaction_type__isnull - The value for the record is null (if true) or is not null.

date
string <date-time>

NOTE: Parameter accepts additional qualifiers appended to the end:
date__year, date__month, date__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).

document_id
integer <int64>

The newdocument with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
document__in - The value for the record is in the provided array parameter (comma-separated values).
document__isnull - The value for the record is null (if true) or is not null.

documents
Array of integers <int64>

The newdocuments that are associated with this note.

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

from_grassroots
boolean
id
integer <int64>

Quorum ID (Primary Key)

interaction_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
interaction_type__in - The value for the record is in the provided array parameter (comma-separated values).
interaction_type__isnull - The value for the record is null (if true) or is not null.

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 108 109 110
members
Array of integers <int64>

The newpersons that are associated with this note.

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

note_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
note_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 NoteType, for an explanation of values.

Enum: 1 2 3
organization_id
integer <int64>

The organization with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
organization__in - The value for the record is in the provided array parameter (comma-separated values).
organization__isnull - The value for the record is null (if true) or is not null.

person_id
integer <int64>

The newperson with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
person__in - The value for the record is in the provided array parameter (comma-separated values).
person__isnull - The value for the record is null (if true) or is not null.

project_id
integer <int64>

The project with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
project__in - The value for the record is in the provided array parameter (comma-separated values).
project__isnull - The value for the record is null (if true) or is not null.

projects
Array of integers <int64>

The projects that are associated with this note.

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

public_organizations
Array of integers <int64>

The publicorganizations that are associated with this note.

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

regulations
Array of integers <int64>

The regulations that are associated with this note.

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

relationship_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
relationship_type__in - The value for the record is in the provided array parameter (comma-separated values).
relationship_type__isnull - The value for the record is null (if true) or is not null.

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
source_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
source_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 UTMSourceType, for an explanation of values.

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
supporter_id
integer <int64>

The newsupporter with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
supporter__in - The value for the record is in the provided array parameter (comma-separated values).
supporter__isnull - The value for the record is null (if true) or is not null.

supporters
Array of integers <int64>

The newsupporters that are associated with this note.

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

teams
Array of integers <int64>

The teams that are associated with this note.

NOTE: Parameter accepts additional qualifiers appended to the end:
teams__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).

vote_id
integer <int64>

The vote with which this note is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
vote__in - The value for the record is in the provided array parameter (comma-separated values).
vote__isnull - The value for the record is null (if true) or is not null.

votes
Array of integers <int64>

The votes that are associated with this note.

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

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.
full_humanized_text - expand full_humanized_text with additional details.
humanized_text - expand humanized_text with additional details.
is_collaborator_comment - expand is_collaborator_comment with additional details.
resource_uri - expand resource_uri with additional details.
tag_dict - expand tag_dict with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Enum: "full_humanized_text" "humanized_text" "is_collaborator_comment" "resource_uri" "tag_dict"
dehydrate_extra
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.bills - expand bills with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "bills"
advanced_search
string

Perform an advanced text search on the datset with the provided text. This search will use the most comprehensive search method available on the requested endpoint, but can take slightly longer to return results.

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

Note retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "alert_cache": { },
  • "amendment": "/api/newamendment/1/",
  • "amendments": [
    ],
  • "amount": 0,
  • "archived": false,
  • "articles": [
    ],
  • "attachments": "/api/attachment/1/",
  • "audit_trail": { },
  • "auto_created": false,
  • "bill": "/api/newbill/1/",
  • "bills": [
    ],
  • "bulk_email": "/api/bulkemail/1/",
  • "bulk_email_id": "/api/bulkemail/1/",
  • "cache_json": { },
  • "cached_limited_to_teams": [
    ],
  • "campaign": "/api/campaign/1/",
  • "check_number": "string",
  • "clicks": 0,
  • "comment_type": 1,
  • "confirmed": false,
  • "created": "2019-08-24T14:15:22Z",
  • "custom_interaction_type": "/api/custominteractiontype/1/",
  • "data_type": 1,
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": false,
  • "delivery_id": "string",
  • "document": "/api/newdocument/1/",
  • "documents": [
    ],
  • "duration": 0,
  • "event": "/api/newevent/1/",
  • "failed_delivery": false,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": false,
  • "from_notes": false,
  • "from_parser": false,
  • "from_qnotes": false,
  • "frozen_cache_json": { },
  • "full_humanized_text": "string",
  • "http_referer": "string",
  • "humanized_text": "string",
  • "ical_id": "string",
  • "icon": "string",
  • "id": 0,
  • "interaction_timezone": 1,
  • "interaction_type": 1,
  • "is_collaborator_comment": true,
  • "is_ical": false,
  • "is_visible_to_partners": false,
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "members": [
    ],
  • "members_count": 0,
  • "message": "string",
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "person": "/api/newperson/1/",
  • "privacy": 1,
  • "project": "/api/project/1/",
  • "projects": [
    ],
  • "public_organizations": [
    ],
  • "public_organizations_count": 0,
  • "raw_content": "",
  • "regions": [
    ],
  • "regulations": [
    ],
  • "relationship_status": true,
  • "relationship_type": 1,
  • "resource_uri": "string",
  • "searchable_created_date": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "supporters": [
    ],
  • "supporters_count": 0,
  • "tag_dict": { },
  • "team_members": [
    ],
  • "team_members_count": 0,
  • "text": "",
  • "text_with_html": "string",
  • "timestamp": { },
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "user_id": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "vote": "/api/vote/1/",
  • "votes": [
    ]
}

Create a single Notes

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

Quorum ID (Primary Key)

Request Body schema: application/json
amendment_id
string <{"id": QUORUM_ID}>

The newamendment with which this note is associated.

amendments
Array of strings <{"id": QUORUM_ID}>

The newamendments that are associated with this note.

amount
number <decimal>
archived
boolean
bill_id
string <{"id": QUORUM_ID}>

The newbill with which this note is associated.

bills
Array of strings <{"id": QUORUM_ID}>

The newbills that are associated with this note.

check_number
string
comment_type
integer <int64>

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

Enum: 1 2 3 4 5 6 7 8 9 10 12 14 15 16 17 18 20 21 22 23 24 25 26 27 28 29 30 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 52 53 54 55 56 57 58 59 60 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
confirmed
boolean
custom_interaction_type_id
string <{"id": QUORUM_ID}>

The custominteractiontype with which this note is associated.

date
string <date-time>
document_id
string <{"id": QUORUM_ID}>

The newdocument with which this note is associated.

documents
Array of strings <{"id": QUORUM_ID}>

The newdocuments that are associated with this note.

duration
integer <int64>

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

Enum: 0 1 2 3 4 5 9 15 18 27 30 36 45 46 54 63 75 90 105 135 150 165 195 210 225
interaction_timezone
integer <int64>

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14
interaction_type
integer <int64>

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 108 109 110
is_visible_to_partners
boolean
limited_to_teams
Array of strings <{"id": QUORUM_ID}>

The teams that are associated with this note.

members
Array of strings <{"id": QUORUM_ID}>

The newpersons that are associated with this note.

person_id
string <{"id": QUORUM_ID}>

The newperson with which this note is associated.

privacy
integer <int64>

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

Enum: 1 2 3 4
project_id
string <{"id": QUORUM_ID}>

The project with which this note is associated.

projects
Array of strings <{"id": QUORUM_ID}>

The projects that are associated with this note.

public_organizations
Array of strings <{"id": QUORUM_ID}>

The publicorganizations that are associated with this note.

regulations
Array of strings <{"id": QUORUM_ID}>

The regulations that are associated with this note.

searchable_date
string
supporter_id
string <{"id": QUORUM_ID}>

The newsupporter with which this note is associated.

supporters
Array of strings <{"id": QUORUM_ID}>

The newsupporters that are associated with this note.

tag_dict
string

String-encoded JSON Object. This field requires special handling.

team_members
Array of strings <{"id": QUORUM_ID}>

The quorumusers that are associated with this note.

teams
Array of strings <{"id": QUORUM_ID}>

The teams that are associated with this note.

text
string
user_id
string <{"id": QUORUM_ID}>

The quorumuser with which this note is associated.

vote_id
string <{"id": QUORUM_ID}>

The vote with which this note is associated.

votes
Array of strings <{"id": QUORUM_ID}>

The votes that are associated with this note.

Responses
200

Note retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "amendment_id": "string",
  • "amendments": [
    ],
  • "amount": 0,
  • "archived": true,
  • "bill_id": "string",
  • "bills": [
    ],
  • "check_number": "string",
  • "comment_type": 1,
  • "confirmed": true,
  • "custom_interaction_type_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "document_id": "string",
  • "documents": [
    ],
  • "duration": 0,
  • "interaction_timezone": 1,
  • "interaction_type": 1,
  • "is_visible_to_partners": true,
  • "limited_to_teams": [
    ],
  • "members": [
    ],
  • "person_id": "string",
  • "privacy": 1,
  • "project_id": "string",
  • "projects": [
    ],
  • "public_organizations": [
    ],
  • "regulations": [
    ],
  • "searchable_date": "string",
  • "supporter_id": "string",
  • "supporters": [
    ],
  • "tag_dict": "string",
  • "team_members": [
    ],
  • "teams": [
    ],
  • "text": "string",
  • "user_id": "string",
  • "vote_id": "string",
  • "votes": [
    ]
}
Response samples
application/json
{
  • "_extra": { },
  • "alert_cache": { },
  • "amendment": "/api/newamendment/1/",
  • "amendments": [
    ],
  • "amount": 0,
  • "archived": false,
  • "articles": [
    ],
  • "attachments": "/api/attachment/1/",
  • "audit_trail": { },
  • "auto_created": false,
  • "bill": "/api/newbill/1/",
  • "bills": [
    ],
  • "bulk_email": "/api/bulkemail/1/",
  • "bulk_email_id": "/api/bulkemail/1/",
  • "cache_json": { },
  • "cached_limited_to_teams": [
    ],
  • "campaign": "/api/campaign/1/",
  • "check_number": "string",
  • "clicks": 0,
  • "comment_type": 1,
  • "confirmed": false,
  • "created": "2019-08-24T14:15:22Z",
  • "custom_interaction_type": "/api/custominteractiontype/1/",
  • "data_type": 1,
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": false,
  • "delivery_id": "string",
  • "document": "/api/newdocument/1/",
  • "documents": [
    ],
  • "duration": 0,
  • "event": "/api/newevent/1/",
  • "failed_delivery": false,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": false,
  • "from_notes": false,
  • "from_parser": false,
  • "from_qnotes": false,
  • "frozen_cache_json": { },
  • "full_humanized_text": "string",
  • "http_referer": "string",
  • "humanized_text": "string",
  • "ical_id": "string",
  • "icon": "string",
  • "id": 0,
  • "interaction_timezone": 1,
  • "interaction_type": 1,
  • "is_collaborator_comment": true,
  • "is_ical": false,
  • "is_visible_to_partners": false,
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "members": [
    ],
  • "members_count": 0,
  • "message": "string",
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "person": "/api/newperson/1/",
  • "privacy": 1,
  • "project": "/api/project/1/",
  • "projects": [
    ],
  • "public_organizations": [
    ],
  • "public_organizations_count": 0,
  • "raw_content": "",
  • "regions": [
    ],
  • "regulations": [
    ],
  • "relationship_status": true,
  • "relationship_type": 1,
  • "resource_uri": "string",
  • "searchable_created_date": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "supporters": [
    ],
  • "supporters_count": 0,
  • "tag_dict": { },
  • "team_members": [
    ],
  • "team_members_count": 0,
  • "text": "",
  • "text_with_html": "string",
  • "timestamp": { },
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "user_id": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "vote": "/api/vote/1/",
  • "votes": [
    ]
}

Retrieve information on a single Note (Historic Interaction / Comment / Donation)

get/note/{id}/
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.
full_humanized_text - expand full_humanized_text with additional details.
humanized_text - expand humanized_text with additional details.
is_collaborator_comment - expand is_collaborator_comment with additional details.
resource_uri - expand resource_uri with additional details.
tag_dict - expand tag_dict with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Enum: "full_humanized_text" "humanized_text" "is_collaborator_comment" "resource_uri" "tag_dict"
dehydrate_extra
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.bills - expand bills with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "bills"
Responses
200

Note retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "alert_cache": { },
  • "amendment": "/api/newamendment/1/",
  • "amendments": [
    ],
  • "amount": 0,
  • "archived": false,
  • "articles": [
    ],
  • "attachments": "/api/attachment/1/",
  • "audit_trail": { },
  • "auto_created": false,
  • "bill": "/api/newbill/1/",
  • "bills": [
    ],
  • "bulk_email": "/api/bulkemail/1/",
  • "bulk_email_id": "/api/bulkemail/1/",
  • "cache_json": { },
  • "cached_limited_to_teams": [
    ],
  • "campaign": "/api/campaign/1/",
  • "check_number": "string",
  • "clicks": 0,
  • "comment_type": 1,
  • "confirmed": false,
  • "created": "2019-08-24T14:15:22Z",
  • "custom_interaction_type": "/api/custominteractiontype/1/",
  • "data_type": 1,
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": false,
  • "delivery_id": "string",
  • "document": "/api/newdocument/1/",
  • "documents": [
    ],
  • "duration": 0,
  • "event": "/api/newevent/1/",
  • "failed_delivery": false,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": false,
  • "from_notes": false,
  • "from_parser": false,
  • "from_qnotes": false,
  • "frozen_cache_json": { },
  • "full_humanized_text": "string",
  • "http_referer": "string",
  • "humanized_text": "string",
  • "ical_id": "string",
  • "icon": "string",
  • "id": 0,
  • "interaction_timezone": 1,
  • "interaction_type": 1,
  • "is_collaborator_comment": true,
  • "is_ical": false,
  • "is_visible_to_partners": false,
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "members": [
    ],
  • "members_count": 0,
  • "message": "string",
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "person": "/api/newperson/1/",
  • "privacy": 1,
  • "project": "/api/project/1/",
  • "projects": [
    ],
  • "public_organizations": [
    ],
  • "public_organizations_count": 0,
  • "raw_content": "",
  • "regions": [
    ],
  • "regulations": [
    ],
  • "relationship_status": true,
  • "relationship_type": 1,
  • "resource_uri": "string",
  • "searchable_created_date": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "supporters": [
    ],
  • "supporters_count": 0,
  • "tag_dict": { },
  • "team_members": [
    ],
  • "team_members_count": 0,
  • "text": "",
  • "text_with_html": "string",
  • "timestamp": { },
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "user_id": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "vote": "/api/vote/1/",
  • "votes": [
    ]
}

Update a single Notes by ID

patch/note/{id}/
Securityapi_key and username
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Request Body schema: application/json
amendment_id
string <{"id": QUORUM_ID}>

The newamendment with which this note is associated.

amendments
Array of strings <{"id": QUORUM_ID}>

The newamendments that are associated with this note.

amount
number <decimal>
archived
boolean
bill_id
string <{"id": QUORUM_ID}>

The newbill with which this note is associated.

bills
Array of strings <{"id": QUORUM_ID}>

The newbills that are associated with this note.

check_number
string
comment_type
integer <int64>

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

Enum: 1 2 3 4 5 6 7 8 9 10 12 14 15 16 17 18 20 21 22 23 24 25 26 27 28 29 30 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 52 53 54 55 56 57 58 59 60 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
confirmed
boolean
custom_interaction_type_id
string <{"id": QUORUM_ID}>

The custominteractiontype with which this note is associated.

date
string <date-time>
document_id
string <{"id": QUORUM_ID}>

The newdocument with which this note is associated.

documents
Array of strings <{"id": QUORUM_ID}>

The newdocuments that are associated with this note.

duration
integer <int64>

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

Enum: 0 1 2 3 4 5 9 15 18 27 30 36 45 46 54 63 75 90 105 135 150 165 195 210 225
interaction_timezone
integer <int64>

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14
interaction_type
integer <int64>

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

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 108 109 110
is_visible_to_partners
boolean
limited_to_teams
Array of strings <{"id": QUORUM_ID}>

The teams that are associated with this note.

members
Array of strings <{"id": QUORUM_ID}>

The newpersons that are associated with this note.

person_id
string <{"id": QUORUM_ID}>

The newperson with which this note is associated.

privacy
integer <int64>

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

Enum: 1 2 3 4
project_id
string <{"id": QUORUM_ID}>

The project with which this note is associated.

projects
Array of strings <{"id": QUORUM_ID}>

The projects that are associated with this note.

public_organizations
Array of strings <{"id": QUORUM_ID}>

The publicorganizations that are associated with this note.

regulations
Array of strings <{"id": QUORUM_ID}>

The regulations that are associated with this note.

searchable_date
string
supporter_id
string <{"id": QUORUM_ID}>

The newsupporter with which this note is associated.

supporters
Array of strings <{"id": QUORUM_ID}>

The newsupporters that are associated with this note.

tag_dict
string

String-encoded JSON Object. This field requires special handling.

team_members
Array of strings <{"id": QUORUM_ID}>

The quorumusers that are associated with this note.

teams
Array of strings <{"id": QUORUM_ID}>

The teams that are associated with this note.

text
string
user_id
string <{"id": QUORUM_ID}>

The quorumuser with which this note is associated.

vote_id
string <{"id": QUORUM_ID}>

The vote with which this note is associated.

votes
Array of strings <{"id": QUORUM_ID}>

The votes that are associated with this note.

Responses
200

Note retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "amendment_id": "string",
  • "amendments": [
    ],
  • "amount": 0,
  • "archived": true,
  • "bill_id": "string",
  • "bills": [
    ],
  • "check_number": "string",
  • "comment_type": 1,
  • "confirmed": true,
  • "custom_interaction_type_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "document_id": "string",
  • "documents": [
    ],
  • "duration": 0,
  • "interaction_timezone": 1,
  • "interaction_type": 1,
  • "is_visible_to_partners": true,
  • "limited_to_teams": [
    ],
  • "members": [
    ],
  • "person_id": "string",
  • "privacy": 1,
  • "project_id": "string",
  • "projects": [
    ],
  • "public_organizations": [
    ],
  • "regulations": [
    ],
  • "searchable_date": "string",
  • "supporter_id": "string",
  • "supporters": [
    ],
  • "tag_dict": "string",
  • "team_members": [
    ],
  • "teams": [
    ],
  • "text": "string",
  • "user_id": "string",
  • "vote_id": "string",
  • "votes": [
    ]
}
Response samples
application/json
{
  • "_extra": { },
  • "alert_cache": { },
  • "amendment": "/api/newamendment/1/",
  • "amendments": [
    ],
  • "amount": 0,
  • "archived": false,
  • "articles": [
    ],
  • "attachments": "/api/attachment/1/",
  • "audit_trail": { },
  • "auto_created": false,
  • "bill": "/api/newbill/1/",
  • "bills": [
    ],
  • "bulk_email": "/api/bulkemail/1/",
  • "bulk_email_id": "/api/bulkemail/1/",
  • "cache_json": { },
  • "cached_limited_to_teams": [
    ],
  • "campaign": "/api/campaign/1/",
  • "check_number": "string",
  • "clicks": 0,
  • "comment_type": 1,
  • "confirmed": false,
  • "created": "2019-08-24T14:15:22Z",
  • "custom_interaction_type": "/api/custominteractiontype/1/",
  • "data_type": 1,
  • "date": "2019-08-24T14:15:22Z",
  • "delivered": false,
  • "delivery_id": "string",
  • "document": "/api/newdocument/1/",
  • "documents": [
    ],
  • "duration": 0,
  • "event": "/api/newevent/1/",
  • "failed_delivery": false,
  • "first_open": "2019-08-24T14:15:22Z",
  • "from_grassroots": false,
  • "from_notes": false,
  • "from_parser": false,
  • "from_qnotes": false,
  • "frozen_cache_json": { },
  • "full_humanized_text": "string",
  • "http_referer": "string",
  • "humanized_text": "string",
  • "ical_id": "string",
  • "icon": "string",
  • "id": 0,
  • "interaction_timezone": 1,
  • "interaction_type": 1,
  • "is_collaborator_comment": true,
  • "is_ical": false,
  • "is_visible_to_partners": false,
  • "limited_to_teams": [
    ],
  • "link_dict": { },
  • "members": [
    ],
  • "members_count": 0,
  • "message": "string",
  • "message_status": 1,
  • "note_type": 1,
  • "num_attempts": 0,
  • "opens": 0,
  • "organization": "/api/organization/1/",
  • "person": "/api/newperson/1/",
  • "privacy": 1,
  • "project": "/api/project/1/",
  • "projects": [
    ],
  • "public_organizations": [
    ],
  • "public_organizations_count": 0,
  • "raw_content": "",
  • "regions": [
    ],
  • "regulations": [
    ],
  • "relationship_status": true,
  • "relationship_type": 1,
  • "resource_uri": "string",
  • "searchable_created_date": "string",
  • "searchable_date": "string",
  • "social_media_type": 1,
  • "source_type": 1,
  • "subject": "string",
  • "submitting_org_name": "string",
  • "supporter": "/api/newsupporter/1/",
  • "supporter_action_type": 1,
  • "supporters": [
    ],
  • "supporters_count": 0,
  • "tag_dict": { },
  • "team_members": [
    ],
  • "team_members_count": 0,
  • "text": "",
  • "text_with_html": "string",
  • "timestamp": { },
  • "unique_identifier": "string",
  • "updated": "2019-08-24T14:15:22Z",
  • "user": "/api/user/1/",
  • "user_id": "/api/user/1/",
  • "utm_campaign": "string",
  • "utm_content": "string",
  • "utm_medium": "string",
  • "utm_source": "string",
  • "utm_term": "string",
  • "vote": "/api/vote/1/",
  • "votes": [
    ]
}
➔ Next to Issues