v1
latestOpenAPI 3.0.02026-08-062438369.6 KBCampaigns
Get Campaign Details
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.
get/campaigns/{id}
Path parameters
idinteger required
The unique VOMO identifier for the campaign to retrieve.
Response
Returns the full campaign record, including all associated projects and their serving dates.
Example response
{
"data": {
"type": "campaign",
"campaign_id": "1",
"campaign_name": "Together",
"description": "Example description.",
"url": "http://app.vomo.org/initiative/together",
"organization": "VOMO",
"organization_slug": "vomo",
"organization_id": 1,
"author_id": 1,
"logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
"created_at": "2016-03-07T07:49:41+00:00",
"updated_at": "2016-03-07T07:49:41+00:00",
"projects": [
{
"type": "project",
"id": "1",
"project_name": "Community Gathering",
"description": "Inviting & meeting new neighbors of the community. Serving meals, setup game stations, face paintings for kids...etc.",
"details": "Wear comfortable shoes!",
"url": "https://app.vomo.org/opportunity/generated-slug",
"organization_id": 1,
"organization": "VOMO",
"organization_slug": "vomo",
"author_id": 1,
"owners": [
{
"id": 1,
"is_primary_owner": true,
"send_notifications": true
}
],
"address": {
"lat": "40.70387040000001",
"lng": "-74.0138541",
"country": "United States",
"locality": "BOWLING GREEN",
"timezone": "America/New_York",
"postal_code": "10004",
"country_short": "US",
"locality_short": "BOWLING GREEN",
"formatted_address": "BOWLING GREEN, NY 10004, USA",
"postal_code_short": "10004",
"administrative_area_level_1": "New York",
"administrative_area_level_1_short": "NY"
},
"created_at": "2016-03-07T07:49:41+00:00",
"updated_at": "2016-03-07T07:49:41+00:00",
"published_at": "2016-03-07T07:49:41+00:00",
"campaigns": [
{
"type": "campaign",
"id": "1",
"campaign_name": "Together",
"description": "Example description.",
"url": "http://app.vomo.org/initiative/together",
"organization": "VOMO",
"organization_id": 1,
"organization_slug": "vomo",
"logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
"updated_at": "2016-03-07T07:49:41+00:00",
"created_at": "2016-03-07T07:49:41+00:00"
}
],
"certificates": [
{
"id": 1,
"name": "Volunteer Application",
"requirement": "Watch tutorial videos.",
"slug": "2d8614a5-31ed-4810-8da2-448f59463e43",
"expiration_in_months": 12,
"creator_id": 1,
"organization_id": 1,
"created_at": "2016-03-07T07:49:41+00:00",
"updated_at": "2016-03-07T07:49:41+00:00"
}
],
"form_completions": [
{
"type": "form_completion",
"project_id": 1,
"participation_id": 1,
"updated_at": "2016-03-07T07:49:41+00:00",
"created_at": "2016-03-07T07:49:41+00:00",
"field_responses": [
{
"type": "form_field_response",
"value": "S"
}
]
}
],
"next_date": {
"type": "project_date",
"starts_at": "2020-01-01T12:00:00+00:00",
"ends_at": "2020-01-01T19:00:00+00:00",
"participant_count": 13
},
"images": [
"https://vomo-cdn.com/media/2019/01/01-sulmLi2Z-l.jpg"
],
"point_person": {
"name": "John Volunteer",
"phone": "5555555555",
"email": "volunteer@vomo.org"
},
"age_limit": 13,
"volunteer_question": "What is your t-shirt size?",
"volunteer_counter_threshold": 10,
"privacy": "PUBLIC",
"all_dates": [
{
"type": "project_date",
"starts_at": "2020-01-01T12:00:00+00:00",
"ends_at": "2020-01-01T19:00:00+00:00",
"participant_count": 13
}
]
}
]
}
}