v1

latestOpenAPI 3.0.02026-08-062438369.6 KB
Projects

List / find Projects

Returns a paginated list of volunteer projects belonging to your organization family. No status filter is applied unless requested: pass the active, published, and/or anytime flags to restrict results by those attributes. Filter by org_slug, name, date range, or event date range to narrow results for a specific integration use case.

get/projects

Query parameters

pageinteger

Page number (if paging results).

active'true' | 'false'

When set to true, limits results to currently active projects; when set to false, to past projects. Omit the parameter to return projects regardless of state — no filter is applied by default.

published'true' | 'false'

When set to true, limits results to published projects; when set to false, to unpublished (draft) projects. Omit the parameter to return projects regardless of publish state — no filter is applied by default.

anytime'true' | 'false'

When set to true, limits results to anytime (open-ended) projects; when set to false, to projects with definite scheduled times. Omit the parameter to return both — no filter is applied by default.

org_slugstring

One or more org slugs (comma separated) projects should belong to.

name_likestring

The project name, or part of a name, to search for.

created_beforestring date-time

Date the Project was created on or before.

created_afterstring date-time

Date the Project was created on or after

updated_beforestring date-time

Date the Project was updated on or before.

updated_afterstring date-time

Date the Project was updated on or after

dates_beforestring date-time

Projects that have dates that started at or before the given date and time

dates_afterstring date-time

Projects that have dates that started at or after the given date and time

Response

Returns the paginated list of projects for your organization family, filtered by the provided query parameters. The response includes pagination links and meta fields to navigate additional pages.

Example response

{
  "data": [
    {
      "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"
      ]
    }
  ]
}