Custom Field

The endpoint for the Custom Fields in your account.

Retrieve multiple Custom Fields based on search critera passed as GET Arguments

get/api/customtag/

The endpoint for the Custom Fields in your account.

Securityapi_key and user_name

Request

query Parameters

archived	boolean Whether the record has been soft-deleted or not.
group_id	integer <int64> The custom field group in which this custom field should display, if any. NOTE: Parameter accepts additional qualifiers appended to the end: `group__in` - The value for the record is in the provided array parameter (comma-separated values). `group__isnull` - The value for the record is null (if `true`) or is not null.
id	integer <int64> The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.
organization_id	integer <int64> The Quorum client associated with this record. 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).
tag_owner	integer <int64> Represent the owner model for this CustomTag, e.g. Supporter, PublicOrganization NOTE: Parameter accepts additional qualifiers appended to the end: `tag_owner__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 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 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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
tag_type	integer <int64> The type of the custom tag, e.g. Number, String, Choose One, Choose Many, etc. NOTE: Parameter accepts additional qualifiers appended to the end: `tag_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 TagType, for an explanation of values. Enum: 1 2 5 6 7 8
updated	string <date-time> When the record was most recently updated. 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

CustomTag retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples

application/json

{"_extra": { },
"archived": true,
"conditional_boolean_value": true,
"conditional_list_value": ["string"
],
"conditional_parent_custom_field": "/api/customtag/1/",
"conditional_string_value": "string",
"created": "2019-08-24T14:15:22Z",
"creator": "string",
"default_boolean_value": true,
"default_multi_value": ["string"
],
"default_string_value": "string",
"default_value": "string",
"description": "string",
"display_null_value": true,
"display_on_create_page": true,
"display_on_filters": true,
"display_on_profile": true,
"external_description": "string",
"external_name": "string",
"group": "/api/customfieldgroup/1/",
"id": 0,
"is_editable": true,
"is_required": true,
"limited_to_teams": ["/api/team/1/"
],
"name": "string",
"options": ["string"
],
"options_new": { },
"organization": "/api/organization/1/",
"precedence": 0,
"resource_uri": "string",
"slug": "string",
"tag_owner": 1,
"tag_type": 1,
"updated": "2019-08-24T14:15:22Z",
"used_to_generate_outbox_email_lists": true
}

Retrieve information on a single Custom Field

get/api/customtag/{id}/

The endpoint for the Custom Fields in your account.

Securityapi_key and user_name

Request

path Parameters

required

integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Responses

200

CustomTag retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples

application/json

{"_extra": { },
"archived": true,
"conditional_boolean_value": true,
"conditional_list_value": ["string"
],
"conditional_parent_custom_field": "/api/customtag/1/",
"conditional_string_value": "string",
"created": "2019-08-24T14:15:22Z",
"creator": "string",
"default_boolean_value": true,
"default_multi_value": ["string"
],
"default_string_value": "string",
"default_value": "string",
"description": "string",
"display_null_value": true,
"display_on_create_page": true,
"display_on_filters": true,
"display_on_profile": true,
"external_description": "string",
"external_name": "string",
"group": "/api/customfieldgroup/1/",
"id": 0,
"is_editable": true,
"is_required": true,
"limited_to_teams": ["/api/team/1/"
],
"name": "string",
"options": ["string"
],
"options_new": { },
"organization": "/api/organization/1/",
"precedence": 0,
"resource_uri": "string",
"slug": "string",
"tag_owner": 1,
"tag_type": 1,
"updated": "2019-08-24T14:15:22Z",
"used_to_generate_outbox_email_lists": true
}

Update a single Custom Field by ID

patch/api/customtag/{id}/

The endpoint for the Custom Fields in your account.

Securityapi_key and user_name

Request

path Parameters

required

integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Request Body schema: application/json

archived	boolean Whether the record has been soft-deleted or not.
conditional_boolean_value	boolean If conditional_parent_custom_field is a boolean type, this field specifies what value the parent must have to render this custom field
conditional_list_value	Array of strings If this custom field is a conditional field, the values on the parent field that would trigger this field to appear.
conditional_parent_custom_field_id	string <{"id": QUORUM_ID}> If the custom field is a conditional field, the parent field that determines when this custom field becomes visible. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}
conditional_string_value	string If conditional_parent_custom_field is a string, select one, or number type, this field specifies what value the parent must have to render this custom field
creator_id	string <{"id": QUORUM_ID}> The user that created this custom field. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}
default_boolean_value	boolean If the tag type is a boolean, this field holds the default value. Otherwise, this field is Null
default_multi_value	Array of strings
default_string_value	string If the tag type is a string, date, number, or single options, this field holds the default value. Otherwise, this field is Null
description	string Text describing the Custom Field
display_null_value	boolean If this field should be displayed on the object's profile page even if the value is null
display_on_create_page	boolean If this field should be displayed on the create page
display_on_filters	boolean If this field should be displayed on the search page
display_on_profile	boolean If this field should be displayed on the object's profile page
external_description	string The description displayed externally to a Supporter or Person as a tooltip
external_name	string The name displayed externally to a Supporter or Person
group_id	string <{"id": QUORUM_ID}> The custom field group in which this custom field should display, if any. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}
is_required	boolean If this field should be required when editing the tag owner
limited_to_teams	Array of strings <{"id": QUORUM_ID}> Used to permission objects. If the User's Teams intersect with the teams associatedwith these teams, the User can see this object Each item provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: [{"id": 410003}, {"id": 410014}]
name	string The name of this custom field.
options	Array of strings
options_new	string The new implementation of options for Custom Fields. Instead of an ArrayField of values, options are a JSONField mapping slugs to value, order, and archived status
precedence	integer <int64> The order in which the tag should display in the front-end user interface.
used_to_generate_outbox_email_lists	boolean If this field should be visible and editable by the Supporter/Person on the unsubscribe page

Responses

200

CustomTag retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples

Payload

application/json

{"archived": true,
"conditional_boolean_value": true,
"conditional_list_value": ["string"
],
"conditional_parent_custom_field_id": "string",
"conditional_string_value": "string",
"creator_id": "string",
"default_boolean_value": true,
"default_multi_value": ["string"
],
"default_string_value": "string",
"description": "string",
"display_null_value": true,
"display_on_create_page": true,
"display_on_filters": true,
"display_on_profile": true,
"external_description": "string",
"external_name": "string",
"group_id": "string",
"is_required": true,
"limited_to_teams": ["string"
],
"name": "string",
"options": ["string"
],
"options_new": "string",
"precedence": 0,
"used_to_generate_outbox_email_lists": true
}

Response samples

application/json

{"_extra": { },
"archived": true,
"conditional_boolean_value": true,
"conditional_list_value": ["string"
],
"conditional_parent_custom_field": "/api/customtag/1/",
"conditional_string_value": "string",
"created": "2019-08-24T14:15:22Z",
"creator": "string",
"default_boolean_value": true,
"default_multi_value": ["string"
],
"default_string_value": "string",
"default_value": "string",
"description": "string",
"display_null_value": true,
"display_on_create_page": true,
"display_on_filters": true,
"display_on_profile": true,
"external_description": "string",
"external_name": "string",
"group": "/api/customfieldgroup/1/",
"id": 0,
"is_editable": true,
"is_required": true,
"limited_to_teams": ["/api/team/1/"
],
"name": "string",
"options": ["string"
],
"options_new": { },
"organization": "/api/organization/1/",
"precedence": 0,
"resource_uri": "string",
"slug": "string",
"tag_owner": 1,
"tag_type": 1,
"updated": "2019-08-24T14:15:22Z",
"used_to_generate_outbox_email_lists": true
}

Create a single Custom Field

post/api/customtag/{id}/

The endpoint for the Custom Fields in your account.

Securityapi_key and user_name

Request

path Parameters

required

integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Request Body schema: application/json

archived	boolean Whether the record has been soft-deleted or not.
conditional_boolean_value	boolean If conditional_parent_custom_field is a boolean type, this field specifies what value the parent must have to render this custom field
conditional_list_value	Array of strings If this custom field is a conditional field, the values on the parent field that would trigger this field to appear.
conditional_parent_custom_field_id	string <{"id": QUORUM_ID}> If the custom field is a conditional field, the parent field that determines when this custom field becomes visible. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}
conditional_string_value	string If conditional_parent_custom_field is a string, select one, or number type, this field specifies what value the parent must have to render this custom field
creator_id	string <{"id": QUORUM_ID}> The user that created this custom field. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}
default_boolean_value	boolean If the tag type is a boolean, this field holds the default value. Otherwise, this field is Null
default_multi_value	Array of strings
default_string_value	string If the tag type is a string, date, number, or single options, this field holds the default value. Otherwise, this field is Null
description	string Text describing the Custom Field
display_null_value	boolean If this field should be displayed on the object's profile page even if the value is null
display_on_create_page	boolean If this field should be displayed on the create page
display_on_filters	boolean If this field should be displayed on the search page
display_on_profile	boolean If this field should be displayed on the object's profile page
external_description	string The description displayed externally to a Supporter or Person as a tooltip
external_name	string The name displayed externally to a Supporter or Person
group_id	string <{"id": QUORUM_ID}> The custom field group in which this custom field should display, if any. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}
is_required	boolean If this field should be required when editing the tag owner
limited_to_teams	Array of strings <{"id": QUORUM_ID}> Used to permission objects. If the User's Teams intersect with the teams associatedwith these teams, the User can see this object Each item provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: [{"id": 410003}, {"id": 410014}]
name	string The name of this custom field.
options	Array of strings
options_new	string The new implementation of options for Custom Fields. Instead of an ArrayField of values, options are a JSONField mapping slugs to value, order, and archived status
precedence	integer <int64> The order in which the tag should display in the front-end user interface.
used_to_generate_outbox_email_lists	boolean If this field should be visible and editable by the Supporter/Person on the unsubscribe page

Responses

200

CustomTag retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples

Payload

application/json

{"archived": true,
"conditional_boolean_value": true,
"conditional_list_value": ["string"
],
"conditional_parent_custom_field_id": "string",
"conditional_string_value": "string",
"creator_id": "string",
"default_boolean_value": true,
"default_multi_value": ["string"
],
"default_string_value": "string",
"description": "string",
"display_null_value": true,
"display_on_create_page": true,
"display_on_filters": true,
"display_on_profile": true,
"external_description": "string",
"external_name": "string",
"group_id": "string",
"is_required": true,
"limited_to_teams": ["string"
],
"name": "string",
"options": ["string"
],
"options_new": "string",
"precedence": 0,
"used_to_generate_outbox_email_lists": true
}

Response samples

application/json

{"_extra": { },
"archived": true,
"conditional_boolean_value": true,
"conditional_list_value": ["string"
],
"conditional_parent_custom_field": "/api/customtag/1/",
"conditional_string_value": "string",
"created": "2019-08-24T14:15:22Z",
"creator": "string",
"default_boolean_value": true,
"default_multi_value": ["string"
],
"default_string_value": "string",
"default_value": "string",
"description": "string",
"display_null_value": true,
"display_on_create_page": true,
"display_on_filters": true,
"display_on_profile": true,
"external_description": "string",
"external_name": "string",
"group": "/api/customfieldgroup/1/",
"id": 0,
"is_editable": true,
"is_required": true,
"limited_to_teams": ["/api/team/1/"
],
"name": "string",
"options": ["string"
],
"options_new": { },
"organization": "/api/organization/1/",
"precedence": 0,
"resource_uri": "string",
"slug": "string",
"tag_owner": 1,
"tag_type": 1,
"updated": "2019-08-24T14:15:22Z",
"used_to_generate_outbox_email_lists": true
}

➔ Next to Custom Field Groups