Campaigns
The campaigns table contains data about campaigns in the organization.
This table can be used to determine campaign names and some settings, as well as metadata about the campaign such as when it was created.
Columns
| Column Name | Description | Type | Nullable |
|---|---|---|---|
| id | The numerical identifier of the object. | INT8 | No |
| name | The name of the campaign, as shown on the user interface. | VARCHAR | No |
| created_by_id | The numerical identifier of the user who created this campaign. Relates to the id column in the users table. |
INT8 | No |
| created_at | The UTC timestamp when this object was created. | TIMESTAMP | No |
| updated_at | The UTC timestamp when this object was updated. | TIMESTAMP | No |
| target_number | The number of entities expected in this campaign, as entered and displayed on the UI. | INT4 | Yes |
| toplines_settings | This column is deprecated and no longer used. | JSONB | Yes |
| support_user_id | The numerical identifier of the user who is listed as the support contact for this campaign in the user interface. Relates to the id column in the users table. |
INT4 | Yes |
| default_country | The default country for the campaign. One of US, CA, or GB. |
VARCHAR(2) | Yes |
| default_entity_type_id | The numerical identifier of the entity type that is set as the default for the campaign. Relates to the id column in the entity_types table. |
INT4 | Yes |
| status | The status of the campaign. One of active or archived. |
VARCHAR | Yes |
| interact_id | The unique identifier of this campaign, as used on the API. | UUID | No |
| show_custom_ids | Whether custom IDs are shown in activist profiles in this campaign or not. | BOOL | Yes |
| allow_organizers_to_export | Whether organizers are allowed to use exports in this campaign or not. | BOOL | Yes |
| show_electoral_districts | Whether electoral districts appear on entity profiles in this campaign or not. | BOOL | No |
| restricted_exporting_settings | A JSON representation of fields, properties, and other settings restricting or allowing what organizers can export from this campaign. | JSONB | Yes |
| activity_stream_as_initial_entity_view | Whether the activity stream is the initial screen loaded when viewing this this campaign or not. | BOOL | No |
| campaign_overview_enabled | This column is currently unused. | BOOL | No |
| default_homepage | This column is currently unused. | BOOL | No |
| calendar_event_canvassing_type | The task type used by default for tasks created on events in this campaign. NULL for standard, 0 for phone banks, 1 for text banks, and 2 for home visits. |
INT4 | Yes |
| calendar_events_enabled | Whether events are active in this campaign or not. | BOOL | No |