--- title: "Get Campaign Details" method: GET path: "/campaigns/{id}" tags: ["Campaigns"] --- # Get Campaign Details `GET /campaigns/{id}` Returns the full detail record for a single campaign, including its associated projects and their dates. The campaign must belong to your organization family; requests for campaigns outside your family return a 400 error. ## Path parameters - `id` integer, required ## Response `200` Returns the full campaign record, including all associated projects and their serving dates. - object - `data` CampaignDetailResource — A VOMO Campaign with full project details - `type` string — The VOMO object type - `campaign_id` string — The VOMO campaign ID (cast to string) - `campaign_name` string — The name of the campaign - `description` string, nullable — The description for the campaign - `url` string — A URL to the campaign on VOMO - `organization` string — The organization name the campaign belongs to - `organization_slug` string — The organization slug the campaign belongs to - `organization_id` integer — The organization ID the campaign belongs to - `author_id` integer, nullable — The VOMO user ID of the person who created the campaign - `logo_url` string, nullable — The URL for the campaign logo image - `created_at` string, date-time — The date and time the campaign was created - `updated_at` string, date-time — The date and time the campaign was last updated - `projects` ProjectDetailResource[] — The full project detail records associated with this campaign. - `type` string — The VOMO object type - `id` string — The VOMO project id (cast to string) - `project_name` string — The name of the project - `description` string — A description for the project - `details` string, nullable — Additional details for volunteers, included in the signup confirmation email. - `url` string — A URL to the project - `organization_id` integer — The Organization ID the project belongs to. - `organization` string — The Organization name the project belongs to. - `organization_slug` string — The Organization slug the project belongs to. - `author_id` integer, nullable — The VOMO user ID of the person who created the project. - `owners` object[] - `id` integer — The VOMO user ID of the person who is an owner - `is_primary_owner` boolean — Whether or not this is a primary owner. There must be one primary owner per project. - `send_notifications` boolean — Whether this owner should receive project notifications. - `address` object, nullable — The address where the project will take place, in Google Maps API format. - `lat` string - `lng` string - `country` string - `locality` string - `timezone` string - `postal_code` string - `country_short` string - `locality_short` string - `formatted_address` string - `postal_code_short` string - `administrative_area_level_1` string - `administrative_area_level_1_short` string - `anytime` boolean — Whether the project is an anytime (open-ended) project with no specific serving dates. - `anywhere` boolean, nullable — Whether the project can be done anywhere (no fixed location). - `draft` boolean — When true, the project is in draft mode and not publicly viewable. - `created_at` string, date-time — The date and time the project was created at - `updated_at` string, date-time — The date and time the project was updated at - `published_at` string — The date and time the project was published. Empty string if not yet published. - `campaigns` CampaignResource[] - `type` string — The VOMO object type - `id` string — The VOMO campaign ID (cast to string) - `campaign_name` string — The name of the campaign - `description` string — The description for the campaign - `url` string — A URL to the campaign on VOMO - `organization` string — The organization name the campaign is in - `organization_id` integer, nullable — The Organization ID the campaign belongs to. - `organization_slug` string, nullable — The organization slug the campaign is in - `author_id` integer — The VOMO user ID of the person who created the campaign - `logo_url` string — The URL for the campaign logo image - `updated_at` string, date-time — The date and time the campaign was updated at - `created_at` string, date-time — The date and time the campaign was created at - `certificates` CertificateResource[] - `id` integer — The ID of the certification - `name` string — The name of the certification - `requirement` string, nullable — A description / requirement for the certification - `slug` string — The slug for the certification - `expiration_in_months` integer, nullable — The certification default expiration after completion in months - `creator_id` integer, nullable — The ID of the certification creator - `organization_id` integer, nullable — The ID of the organization the certification belongs to - `created_at` string, date-time — The date and time the certification was created at - `updated_at` string, date-time — The date and time the certification was last updated at - `form_completions` FormCompletionResource[] - `type` string — The type of VOMO Object - `id` integer — The ID of the form completion - `form_id` integer — The ID of the form - `user_id` integer — The ID of the user who completed the form - `project_id` integer, nullable — The ID of the project this form submission is associated with - `participation_id` integer, nullable — The ID of the participation this form submission is associated with - `updated_at` string, date-time — The date and time the form completion was updated at - `created_at` string, date-time — The date and time the form completion was created at - `field_responses` FormFieldResponseResource[] — The form field responses - `type` string — The type of VOMO Object - `id` integer — The ID of the response - `form_completion_id` integer — The ID of the form completion - `user_id` integer — The ID of the user who completed the form field - `field_id` integer — The ID of the form field - `value` string, nullable — The raw answer value for this field response. What this contains varies by field type: SHORTTEXT and LONGTEXT — the text the volunteer entered; DROPDOWN — the name of the selected option; GROUP — a JSON array of group IDs the volunteer was assigned to; DOCUMENTUPLOAD — the identifier of the uploaded file; WAIVER — the acceptance string; MULTIPLESELECT — not currently populated (selections for multiple-select fields are stored separately and are not returned in this field). - `next_date` HappeningResource — A VOMO Happening - `type` string — The type of VOMO object - `id` integer — Project Date ID - `starts_at` string, date-time — The date and time when a Project Date will start - `ends_at` string, date-time — The date and time when a Project Date will end - `participant_count` integer — The total number of confirmed participants for this date - `images` string[] — An array of project image URLs (large size). - `point_person` object — Identify a person to contact or meet on the day of the Project. This contact info goes in the signup confirmation email, but this person does not receive notifications. - `name` string - `phone` string - `email` string - `allow_guests` boolean — Whether to allow volunteers to bring guests - `age_limit` integer — The minimum age a volunteer must be - `volunteer_question` string — Ask your volunteers to provide additional information about themselves as they register. This field will be required to join the Serving Date. - `participant_approval_required` boolean — Volunteers must be approved by the organizer before their spot is reserved. - `background_check_required` boolean — Volunteers must have a background check before signing up for your Project. - `show_volunteer_counter` boolean — Display number of participants. Note that this will only show on the project page if it is an Anytime project - `volunteer_counter_threshold` integer — The minimum number of volunteers signed up before the counter is shown. Note that this will only show on the project page if it is an Anytime project - `privacy` 'PUBLIC' | 'PRIVATE' | 'UNLISTED' — The visibility of the project. Possible values: `PUBLIC` — accessible by all VOMO users; `PRIVATE` — accessible only by members of the organization (those in the People list); `UNLISTED` — not listed publicly but accessible via direct link. - `all_dates` HappeningResource[] — All serving dates for the project. Present only when the 'happenings' relation is loaded. - `type` string — The type of VOMO object - `id` integer — Project Date ID - `starts_at` string, date-time — The date and time when a Project Date will start - `ends_at` string, date-time — The date and time when a Project Date will end - `participant_count` integer — The total number of confirmed participants for this date ## Other responses - `400` — The requested campaign exists but does not belong to your organization family. - `401` — Authentication credentials are missing or invalid. - `404` — No campaign exists with the provided ID. - `429` — You have exceeded the rate limit of 30 requests per minute per API key. - `500` — An unexpected server error occurred. --- [API](https://skmtc.net/vomo/apis/vomo-api.md) · [All operations](https://skmtc.net/vomo/apis/vomo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vomo/vomo-api/versions/1582d52b5f1f/schema)