| archived | boolean |
| conditional_parent_custom_field_id | integer <int64> The customtag with which this customtag is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| display_on_create_page | boolean |
| display_on_profile | boolean |
| external_name | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| group_id | integer <int64> The customfieldgroup with which this customtag is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| id | integer <int64> Quorum ID (Primary Key) |
| is_required | boolean |
| name | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| organization_id | integer <int64> The organization with which this customtag is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| slug | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| tag_owner | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name QuorumDataType, for an explanation of values. |
| tag_type | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name TagType, for an explanation of values. |
| updated | string <date-time> NOTE: Parameter accepts additional qualifiers appended to the end: |
| 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. |
| 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). |
CustomTag retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "archived": false,
- "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": false,
- "display_on_create_page": true,
- "display_on_filters": true,
- "display_on_profile": true,
- "external_description": "string",
- "external_name": "string",
- "group": "/api/customfieldgroup/1/",
- "group_name": "string",
- "id": 0,
- "is_editable": true,
- "is_hyperlinkable": false,
- "is_required": false,
- "limited_to_teams": [
- "/api/team/1/"
], - "name": "string",
- "option_display_type": 0,
- "options": [
- "string"
], - "options_new": { },
- "organization": "/api/organization/1/",
- "power_search_data_set": 1,
- "precedence": 0,
- "resource_uri": "string",
- "slug": "string",
- "tag_owner": 12,
- "tag_type": 1,
- "updated": "2019-08-24T14:15:22Z",
- "used_to_generate_outbox_email_lists": false
}| archived | boolean |
| conditional_boolean_value | boolean |
| conditional_list_value | Array of strings |
| conditional_parent_custom_field_id | string <{"id": QUORUM_ID}> The customtag with which this customtag is associated. |
| conditional_string_value | string |
| creator_id | string <{"id": QUORUM_ID}> The quorumuser with which this customtag is associated. |
| default_boolean_value | boolean |
| default_multi_value | Array of strings |
| default_string_value | string |
| description | string |
| display_null_value | boolean |
| display_on_create_page | boolean |
| display_on_filters | boolean |
| display_on_profile | boolean |
| external_description | string |
| external_name | string |
| group_id | string <{"id": QUORUM_ID}> The customfieldgroup with which this customtag is associated. |
| is_hyperlinkable | boolean |
| is_required | boolean |
| limited_to_teams | Array of strings <{"id": QUORUM_ID}> The teams that are associated with this customtag. |
| name | string |
| option_display_type | integer <int64> See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name SupporterTagOptionDisplayType, for an explanation of values. |
| options | Array of strings |
| options_new | string String-encoded JSON Object. This field requires special handling. |
| power_search_data_set | integer <int64> See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name QuorumDataType, for an explanation of values. |
| precedence | integer <int64> |
| used_to_generate_outbox_email_lists | boolean |
CustomTag retrieved successfully
improperly configured request
authorization failure
internal server error
{- "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_hyperlinkable": true,
- "is_required": true,
- "limited_to_teams": [
- "string"
], - "name": "string",
- "option_display_type": 0,
- "options": [
- "string"
], - "options_new": "string",
- "power_search_data_set": 1,
- "precedence": 0,
- "used_to_generate_outbox_email_lists": true
}{- "_extra": { },
- "archived": false,
- "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": false,
- "display_on_create_page": true,
- "display_on_filters": true,
- "display_on_profile": true,
- "external_description": "string",
- "external_name": "string",
- "group": "/api/customfieldgroup/1/",
- "group_name": "string",
- "id": 0,
- "is_editable": true,
- "is_hyperlinkable": false,
- "is_required": false,
- "limited_to_teams": [
- "/api/team/1/"
], - "name": "string",
- "option_display_type": 0,
- "options": [
- "string"
], - "options_new": { },
- "organization": "/api/organization/1/",
- "power_search_data_set": 1,
- "precedence": 0,
- "resource_uri": "string",
- "slug": "string",
- "tag_owner": 12,
- "tag_type": 1,
- "updated": "2019-08-24T14:15:22Z",
- "used_to_generate_outbox_email_lists": false
}CustomTag retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "archived": false,
- "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": false,
- "display_on_create_page": true,
- "display_on_filters": true,
- "display_on_profile": true,
- "external_description": "string",
- "external_name": "string",
- "group": "/api/customfieldgroup/1/",
- "group_name": "string",
- "id": 0,
- "is_editable": true,
- "is_hyperlinkable": false,
- "is_required": false,
- "limited_to_teams": [
- "/api/team/1/"
], - "name": "string",
- "option_display_type": 0,
- "options": [
- "string"
], - "options_new": { },
- "organization": "/api/organization/1/",
- "power_search_data_set": 1,
- "precedence": 0,
- "resource_uri": "string",
- "slug": "string",
- "tag_owner": 12,
- "tag_type": 1,
- "updated": "2019-08-24T14:15:22Z",
- "used_to_generate_outbox_email_lists": false
}| archived | boolean |
| conditional_boolean_value | boolean |
| conditional_list_value | Array of strings |
| conditional_parent_custom_field_id | string <{"id": QUORUM_ID}> The customtag with which this customtag is associated. |
| conditional_string_value | string |
| creator_id | string <{"id": QUORUM_ID}> The quorumuser with which this customtag is associated. |
| default_boolean_value | boolean |
| default_multi_value | Array of strings |
| default_string_value | string |
| description | string |
| display_null_value | boolean |
| display_on_create_page | boolean |
| display_on_filters | boolean |
| display_on_profile | boolean |
| external_description | string |
| external_name | string |
| group_id | string <{"id": QUORUM_ID}> The customfieldgroup with which this customtag is associated. |
| is_hyperlinkable | boolean |
| is_required | boolean |
| limited_to_teams | Array of strings <{"id": QUORUM_ID}> The teams that are associated with this customtag. |
| name | string |
| option_display_type | integer <int64> See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name SupporterTagOptionDisplayType, for an explanation of values. |
| options | Array of strings |
| options_new | string String-encoded JSON Object. This field requires special handling. |
| power_search_data_set | integer <int64> See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name QuorumDataType, for an explanation of values. |
| precedence | integer <int64> |
| used_to_generate_outbox_email_lists | boolean |
CustomTag retrieved successfully
improperly configured request
authorization failure
internal server error
{- "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_hyperlinkable": true,
- "is_required": true,
- "limited_to_teams": [
- "string"
], - "name": "string",
- "option_display_type": 0,
- "options": [
- "string"
], - "options_new": "string",
- "power_search_data_set": 1,
- "precedence": 0,
- "used_to_generate_outbox_email_lists": true
}{- "_extra": { },
- "archived": false,
- "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": false,
- "display_on_create_page": true,
- "display_on_filters": true,
- "display_on_profile": true,
- "external_description": "string",
- "external_name": "string",
- "group": "/api/customfieldgroup/1/",
- "group_name": "string",
- "id": 0,
- "is_editable": true,
- "is_hyperlinkable": false,
- "is_required": false,
- "limited_to_teams": [
- "/api/team/1/"
], - "name": "string",
- "option_display_type": 0,
- "options": [
- "string"
], - "options_new": { },
- "organization": "/api/organization/1/",
- "power_search_data_set": 1,
- "precedence": 0,
- "resource_uri": "string",
- "slug": "string",
- "tag_owner": 12,
- "tag_type": 1,
- "updated": "2019-08-24T14:15:22Z",
- "used_to_generate_outbox_email_lists": false
}