Get Project Details

GET

https://api.vomo.org/v1/projects/:id

GET

/v1/projects/:id

curl https://api.vomo.org/v1/projects/1 \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "data": [
    {
      "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"
        }
      ],
      "age_limit": 13,
      "all_dates": [
        {
          "type": "project_date",
          "id": 1,
          "starts_at": "2020-01-01T12:00:00+00:00",
          "ends_at": "2020-01-01T19:00:00+00:00",
          "participant_count": 13
        }
      ],
      "allow_guests": 1,
      "background_check_required": 1,
      "campaigns": [
        {
          "type": "campaign",
          "id": 1,
          "campaign_name": "Together",
          "description": "Example description.",
          "url": "http://app.vomo.org/initiative/together",
          "organization": "VOMO",
          "organization_slug": "VOMO",
          "author_id": 1,
          "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": [
        [
          {
            "type": "certificate",
            "id": 1,
            "name": "Volunteer Application",
            "requirement": "Watch tutorial videos.",
            "slug": "SHORTTEXT",
            "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"
          }
        ]
      ],
      "created_at": "2016-03-07T07:49:41+00:00",
      "description": "Inviting & meeting new neighbors of the community. Serving meals, setup game stations, face paintings for kids...etc.",
      "details": "Wear comfortable shoes!",
      "draft": 0,
      "form_completions": [
        {
          "type": "form_completion",
          "id": 1,
          "form_id": 1,
          "user_id": 1,
          "project_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",
              "id": 1,
              "form_completion_id": 1,
              "user_id": 1,
              "field_id": 1,
              "value": "S"
            }
          ]
        }
      ],
      "id": 1,
      "images": [
        "https://web-assets.vomo.org/categories/animals/Animals.jpg"
      ],
      "name": "Community Gathering",
      "next_date": {
        "type": "project_date",
        "id": 1,
        "starts_at": "2020-01-01T12:00:00+00:00",
        "ends_at": "2020-01-01T19:00:00+00:00",
        "participant_count": 13
      },
      "organization": "VOMO",
      "organization_id": 1,
      "organization_slug": "VOMO",
      "owners": [
        {
          "id": 1,
          "is_primary_owner": 1,
          "send_notifications": 1
        }
      ],
      "participant_approval_required": 1,
      "point_person": {
        "name": "John Volunteer",
        "phone": "5555555555",
        "email": "volunteer@vomo.org"
      },
      "privacy": "PUBLIC",
      "project_name": "Community Gathering",
      "published_at": "2016-03-07T07:49:41+00:00",
      "show_volunteer_counter": 1,
      "type": "project",
      "updated_at": "2016-03-07T07:49:41+00:00",
      "url": "https://app.vomo.org/opportunity/generated-slug",
      "volunteer_counter_threshold": 10,
      "volunteer_question": "What is your t-shirt size?"
    }
  ],
  "links": {
    "first": "https://api.vomo.org/v1/projects?page=4",
    "last": "https://api.vomo.org/v1/projects?page=4",
    "prev": "null",
    "next": "https://api.vomo.org/v1/projects?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 15,
    "path": "https://api.vomo.org/v1/projects",
    "per_page": 15,
    "total": 49
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired

VOMO Project ID

Response

successful operation

datalist of objectsOptional

Project details

linksobjectOptional

Project details

metaobjectOptional

Project details