List / find Projects

GET

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

GET

/v1/projects

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

200Retrieved

{
  "data": [
    {
      "type": "project",
      "id": 1,
      "name": "Community Gathering",
      "project_name": "Community Gathering",
      "description": "Inviting & meeting new neighbors of the community. Serving meals, setup game stations, face paintings for kids...etc.",
      "url": "https://app.vomo.org/opportunity/generated-slug",
      "organization": "VOMO",
      "organization_id": 1,
      "organization_slug": "VOMO",
      "updated_at": "2016-03-07T07:49:41+00:00",
      "created_at": "2016-03-07T07:49:41+00:00",
      "published_at": "2016-03-07T07:49:41+00:00",
      "images": [
        "https://web-assets.vomo.org/categories/animals/Animals.jpg"
      ],
      "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"
        }
      ],
      "owners": [
        {
          "id": 1,
          "is_primary_owner": 1,
          "send_notifications": 1
        }
      ],
      "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"
        }
      ],
      "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"
          }
        ]
      ],
      "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"
            }
          ]
        }
      ]
    }
  ],
  "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.

Query parameters

pageintegerOptional

Page number (if paging results).

activeenumOptionalDefaults to true

This flag will limit results to either active or inactive projects. By default, results are limited to active projects. Omit this flag to return all.

Allowed values:

publishedenumOptionalDefaults to true

This flag will limit results to either published or unpublished projects. By default, results are limited to published projects. Omit this flag to return all.

Allowed values:

anytimeenumOptionalDefaults to false

This flag will filter the results to include or exclude anytime projects. By default, results are limited to projects with definite times. Omit this flag to return all.

Allowed values:

org_slugstringOptional

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

name_likestringOptional

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

created_beforedatetimeOptional

Date the Project was created on or before.

created_afterdatetimeOptional

Date the Project was created on or after

updated_beforedatetimeOptional

Date the Project was updated on or before.

updated_afterdatetimeOptional

Date the Project was updated on or after

dates_beforedatetimeOptional

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

dates_afterdatetimeOptional

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

Response

successful operation

datalist of objectsOptional

linksobjectOptional

metaobjectOptional