Sponsorship endpoint

GET api/sponsorships/

Returns a collection of sponsorships for a specified program.

Required Parameters

  • sponsorship_program_id: Returns only the sponsorships where the sponsorship_program_id matches with this parameter.  This is the Sponsorship Program slug.

Exemple Result

{
  "sponsorships": [
    {
      "id": 1234,
      "name": " Sample",
      "nickname": null,
      "slug": "sample-slug",
      "description": "lorem ipsum",
      "about": "lorem ipsum",
      "pledge_type": "child",
      "images": {
        "large": "https://example.com/cover_photo/13021/1234.jpeg",
        "medium": "https://example.com/widget_image/14791/591234.jpg",
        "small": "https://example.com/avatar/image/random-background.jpg"
      },
      "region_id": null,
      "event_id": null,
      "sponsorship_program_id": 123,
      "is_sponsored": true,
      "sponsorship_model": "multiple",
      "created_at": "2022/05/11 21:00:43 +0000",
      "quantity_taken": 5,
      "number_available": 0,
      "status": "fully_sponsored",
      "location": "Bahamas",
      "funding_per": 20.0,
      "funding_goal": "100.0",
      "age": 7,
      "gender": "Male",
      "custom_fields": {},
      "sponsors_goal": 5
    }
  ]
}