Supporters

Actions available on supporters.


List

Retrieve a list of matching supporters.

Request

  • url: /admin/api/v2/supporters
  • method: GET
  • parameters:

    • id: optional, string, exact match
    • name: optional, string, partial match

Response

supporters.json
{
  "data": [
    {
      "id": "7GZEJPE2",
      "active": true,
      "first_name": "Casimer",
      "last_name": "Schuppe",
      "email": "casimer.schuppe@example.com",
      "type": "Individual",
      "email_opt_in": false,
      "vendor_contact_id": null,
      "billing_address": {
        "first_name": "Casimer",
        "last_name": "Schuppe",
        "company": null,
        "email": "casimer.schuppe@example.com",
        "address1": "7 W 32nd St",
        "address2": "Apt. 917",
        "city": "Erie",
        "state": "PA",
        "zip": "16502",
        "country": "US",
        "phone": "1-218-268-8549 x272"
      },
      "shipping_address": {
        "first_name": "Casimer",
        "last_name": "Schuppe",
        "company": null,
        "email": "casimer.schuppe@example.com",
        "address1": "7 W 32nd St",
        "address2": "Apt. 917",
        "city": "Erie",
        "state": "PA",
        "zip": "16502",
        "country": "US",
        "phone": "1-218-268-8549 x272"
      },
      "created_at": "2021-06-01T12:00:00Z",
      "updated_at": "2021-06-01T12:00:00Z",
      "membership": {
        "id": "P59EKZDK",
        "name": "voluptatem est",
        "description": "Et quos doloremque facere et quaerat sint sint.",
        "sequence": null,
        "default_url": "https://hane.com/quod-ut-officia-adipisci-aut-vel.html",
        "days_to_expire": 20,
        "show_in_profile": false,
        "public_name": "porro accusamus",
        "public_description": "Accusamus omnis consequuntur omnis rerum dolorem cum voluptates. Nostrum atque sed unde repudiandae est. Iure sed doloremque nesciunt tempora nobis et.",
        "members_can_manage_optin": true,
        "members_can_manage_optout": false,
        "members_can_view_directory": false,
        "double_optin_required": false,
        "should_display_badge": false,
        "dp_id": 6776,
        "created_by": 1,
        "created_at": "2021-06-01T12:00:00Z",
        "updated_by": 1,
        "updated_at": "2021-06-01T12:00:00Z",
        "deleted_at": "",
        "deleted_by": null,
        "starts_at": "2021-11-03T13:22:02Z"
      },
      "groups": [
        {
          "id": "P59EKZDK",
          "name": "voluptatem est",
          "description": "Et quos doloremque facere et quaerat sint sint.",
          "sequence": null,
          "default_url": "https://hane.com/quod-ut-officia-adipisci-aut-vel.html",
          "days_to_expire": 20,
          "show_in_profile": false,
          "public_name": "porro accusamus",
          "public_description": "Accusamus omnis consequuntur omnis rerum dolorem cum voluptates. Nostrum atque sed unde repudiandae est. Iure sed doloremque nesciunt tempora nobis et.",
          "members_can_manage_optin": true,
          "members_can_manage_optout": false,
          "members_can_view_directory": false,
          "double_optin_required": false,
          "should_display_badge": false,
          "dp_id": 6776,
          "created_by": 1,
          "created_at": "2021-06-01T12:00:00Z",
          "updated_by": 1,
          "updated_at": "2021-06-01T12:00:00Z",
          "deleted_at": "",
          "deleted_by": null,
          "starts_at": "2021-11-03T13:22:02Z"
        }
      ]
    },
    {
      "id": "P59EKZDK",
      "active": true,
      "first_name": "Gladys",
      "last_name": "Brekke",
      "email": "gladys.brekke@example.com",
      "type": "Individual",
      "email_opt_in": false,
      "vendor_contact_id": null,
      "billing_address": {
        "first_name": "Gladys",
        "last_name": "Brekke",
        "company": null,
        "email": "gladys.brekke@example.com",
        "address1": "47565 W Grand Ave",
        "address2": null,
        "city": "Newark",
        "state": "NJ",
        "zip": "07105",
        "country": "US",
        "phone": "(415) 426-3568 x989"
      },
      "shipping_address": {
        "first_name": "Gladys",
        "last_name": "Brekke",
        "company": null,
        "email": "gladys.brekke@example.com",
        "address1": "47565 W Grand Ave",
        "address2": null,
        "city": "Newark",
        "state": "NJ",
        "zip": "07105",
        "country": "US",
        "phone": "(415) 426-3568 x989"
      },
      "created_at": "2021-06-01T12:00:00Z",
      "updated_at": "2021-06-01T12:00:00Z",
      "membership": {
        "id": "MKYEL8EW",
        "name": "est quis modi",
        "description": "Aut consequatur dolor possimus aut consequuntur aperiam. Rem sit aut numquam nisi itaque explicabo.",
        "sequence": null,
        "default_url": "http://www.altenwerth.net/officia-sit-consequatur-laudantium-laboriosam-molestias-quae",
        "days_to_expire": 340,
        "show_in_profile": false,
        "public_name": "vel facere",
        "public_description": "Voluptatem ad et ut reprehenderit consequuntur voluptatibus esse nobis. Voluptas laudantium et harum ipsum dolor. Qui sequi voluptas et iure id aut ratione. Consequatur cumque distinctio iste rem in ut.",
        "members_can_manage_optin": false,
        "members_can_manage_optout": false,
        "members_can_view_directory": false,
        "double_optin_required": true,
        "should_display_badge": false,
        "dp_id": 7852,
        "created_by": 1,
        "created_at": "2021-06-01T12:00:00Z",
        "updated_by": 1,
        "updated_at": "2021-06-01T12:00:00Z",
        "deleted_at": "",
        "deleted_by": null,
        "starts_at": "2021-06-02 06:25:36 UTC"
      },
      "groups": [
        {
          "id": "MKYEL8EW",
          "name": "est quis modi",
          "description": "Aut consequatur dolor possimus aut consequuntur aperiam. Rem sit aut numquam nisi itaque explicabo.",
          "sequence": null,
          "default_url": "http://www.altenwerth.net/officia-sit-consequatur-laudantium-laboriosam-molestias-quae",
          "days_to_expire": 340,
          "show_in_profile": false,
          "public_name": "vel facere",
          "public_description": "Voluptatem ad et ut reprehenderit consequuntur voluptatibus esse nobis. Voluptas laudantium et harum ipsum dolor. Qui sequi voluptas et iure id aut ratione. Consequatur cumque distinctio iste rem in ut.",
          "members_can_manage_optin": false,
          "members_can_manage_optout": false,
          "members_can_view_directory": false,
          "double_optin_required": true,
          "should_display_badge": false,
          "dp_id": 7852,
          "created_by": 1,
          "created_at": "2021-06-01T12:00:00Z",
          "updated_by": 1,
          "updated_at": "2021-06-01T12:00:00Z",
          "deleted_at": "",
          "deleted_by": null,
          "starts_at": "2021-06-02 06:25:36 UTC"
        },
        {
          "id": "KJLEMLD8",
          "name": "quam rem voluptas",
          "description": "Sequi sapiente nihil ipsam quia fugiat quidem sit.",
          "sequence": null,
          "default_url": "http://mohr.com/aut-veniam-voluptas-dolor-commodi-qui-corporis",
          "days_to_expire": 77,
          "show_in_profile": false,
          "public_name": "voluptatum numquam commodi possimus",
          "public_description": "Necessitatibus quam quia animi omnis et. Eum temporibus adipisci atque repellendus quia. Aperiam cumque ratione sed illum enim neque. Magni ipsum et ut porro cum non autem quia.",
          "members_can_manage_optin": true,
          "members_can_manage_optout": true,
          "members_can_view_directory": false,
          "double_optin_required": false,
          "should_display_badge": false,
          "dp_id": 3669,
          "created_by": 1,
          "created_at": "2021-06-01T12:00:00Z",
          "updated_by": 1,
          "updated_at": "2021-06-01T12:00:00Z",
          "deleted_at": "",
          "deleted_by": null,
          "starts_at": "2021-10-08 12:59:20 UTC"
        }
      ]
    },
    {
      "id": "MKYEL8EW",
      "active": true,
      "first_name": "Kathleen",
      "last_name": "Kihn",
      "email": "kathleen.kihn@example.com",
      "type": "Individual",
      "email_opt_in": false,
      "vendor_contact_id": null,
      "billing_address": {
        "first_name": "Kathleen",
        "last_name": "Kihn",
        "company": null,
        "email": "kathleen.kihn@example.com",
        "address1": "678 3rd Ave",
        "address2": null,
        "city": "Miami",
        "state": "FL",
        "zip": "33196",
        "country": "US",
        "phone": "+1 (553) 248-3542"
      },
      "shipping_address": {
        "first_name": "Kathleen",
        "last_name": "Kihn",
        "company": null,
        "email": "kathleen.kihn@example.com",
        "address1": "678 3rd Ave",
        "address2": null,
        "city": "Miami",
        "state": "FL",
        "zip": "33196",
        "country": "US",
        "phone": "+1 (553) 248-3542"
      },
      "created_at": "2021-06-01T12:00:00Z",
      "updated_at": "2021-06-01T12:00:00Z",
      "membership": {
        "id": "NP7EN4EG",
        "name": "ea",
        "description": "Sit quis est amet illum ipsa velit aut. Ut voluptas sit reiciendis ex quia quas et.",
        "sequence": null,
        "default_url": "https://medhurst.info/aut-sed-perferendis-voluptatem.html",
        "days_to_expire": 251,
        "show_in_profile": false,
        "public_name": "iure mollitia ab ea",
        "public_description": "Error repellendus accusamus veniam sunt eum repudiandae. Dignissimos ducimus sed eius rerum. Enim quos eos laborum eveniet at commodi distinctio. Aliquam sit ut pariatur quia sit voluptatem omnis.",
        "members_can_manage_optin": false,
        "members_can_manage_optout": false,
        "members_can_view_directory": false,
        "double_optin_required": false,
        "should_display_badge": false,
        "dp_id": 1170,
        "created_by": 1,
        "created_at": "2021-06-01T12:00:00Z",
        "updated_by": 1,
        "updated_at": "2021-06-01T12:00:00Z",
        "deleted_at": "",
        "deleted_by": null,
        "starts_at": "2021-09-29 05:36:05 UTC"
      },
      "groups": [
        {
          "id": "NP7EN4EG",
          "name": "ea",
          "description": "Sit quis est amet illum ipsa velit aut. Ut voluptas sit reiciendis ex quia quas et.",
          "sequence": null,
          "default_url": "https://medhurst.info/aut-sed-perferendis-voluptatem.html",
          "days_to_expire": 251,
          "show_in_profile": false,
          "public_name": "iure mollitia ab ea",
          "public_description": "Error repellendus accusamus veniam sunt eum repudiandae. Dignissimos ducimus sed eius rerum. Enim quos eos laborum eveniet at commodi distinctio. Aliquam sit ut pariatur quia sit voluptatem omnis.",
          "members_can_manage_optin": false,
          "members_can_manage_optout": false,
          "members_can_view_directory": false,
          "double_optin_required": false,
          "should_display_badge": false,
          "dp_id": 1170,
          "created_by": 1,
          "created_at": "2021-06-01T12:00:00Z",
          "updated_by": 1,
          "updated_at": "2021-06-01T12:00:00Z",
          "deleted_at": "",
          "deleted_by": null,
          "starts_at": "2021-09-29 05:36:05 UTC"
        }
      ]
    }
  ],
  "links": {
    "first": "https://your-domain.givecloud.co/admin/api/v2/supporters?page=1",
    "last": "https://your-domain.givecloud.co/admin/api/v2/supporters?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v2/supporters?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://your-domain.givecloud.co/admin/api/v2/supporters",
    "per_page": 15,
    "to": 3,
    "total": 3
  }
}

Get

Retrieve the first matching supporter. This returns a 404 if there is no matching supporter found.

Request

  • url: /admin/api/v2/supporters/{id}
  • method: GET
  • parameters:

    • id: string, exact match

Response

supporter.json
{
  "id": "7GZEJPE2",
  "active": true,
  "first_name": "Casimer",
  "last_name": "Schuppe",
  "email": "casimer.schuppe@example.com",
  "type": "Individual",
  "email_opt_in": false,
  "vendor_contact_id": null,
  "billing_address": {
    "first_name": "Casimer",
    "last_name": "Schuppe",
    "company": null,
    "email": "casimer.schuppe@example.com",
    "address1": "7 W 32nd St",
    "address2": "Apt. 917",
    "city": "Erie",
    "state": "PA",
    "zip": "16502",
    "country": "US",
    "phone": "1-218-268-8549 x272"
  },
  "shipping_address": {
    "first_name": "Casimer",
    "last_name": "Schuppe",
    "company": null,
    "email": "casimer.schuppe@example.com",
    "address1": "7 W 32nd St",
    "address2": "Apt. 917",
    "city": "Erie",
    "state": "PA",
    "zip": "16502",
    "country": "US",
    "phone": "1-218-268-8549 x272"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z",
  "membership": {
    "id": "P59EKZDK",
    "name": "voluptatem est",
    "description": "Et quos doloremque facere et quaerat sint sint.",
    "sequence": null,
    "default_url": "https://hane.com/quod-ut-officia-adipisci-aut-vel.html",
    "days_to_expire": 20,
    "show_in_profile": false,
    "public_name": "porro accusamus",
    "public_description": "Accusamus omnis consequuntur omnis rerum dolorem cum voluptates. Nostrum atque sed unde repudiandae est. Iure sed doloremque nesciunt tempora nobis et.",
    "members_can_manage_optin": true,
    "members_can_manage_optout": false,
    "members_can_view_directory": false,
    "double_optin_required": false,
    "should_display_badge": false,
    "dp_id": 6776,
    "created_by": 1,
    "created_at": "2021-06-01T12:00:00Z",
    "updated_by": 1,
    "updated_at": "2021-06-01T12:00:00Z",
    "deleted_at": "",
    "deleted_by": null,
    "starts_at": "2021-11-03T13:22:02Z"
  },
  "groups": [
    {
      "id": "P59EKZDK",
      "name": "voluptatem est",
      "description": "Et quos doloremque facere et quaerat sint sint.",
      "sequence": null,
      "default_url": "https://hane.com/quod-ut-officia-adipisci-aut-vel.html",
      "days_to_expire": 20,
      "show_in_profile": false,
      "public_name": "porro accusamus",
      "public_description": "Accusamus omnis consequuntur omnis rerum dolorem cum voluptates. Nostrum atque sed unde repudiandae est. Iure sed doloremque nesciunt tempora nobis et.",
      "members_can_manage_optin": true,
      "members_can_manage_optout": false,
      "members_can_view_directory": false,
      "double_optin_required": false,
      "should_display_badge": false,
      "dp_id": 6776,
      "created_by": 1,
      "created_at": "2021-06-01T12:00:00Z",
      "updated_by": 1,
      "updated_at": "2021-06-01T12:00:00Z",
      "deleted_at": "",
      "deleted_by": null,
      "starts_at": "2021-11-03T13:22:02Z"
    }
  ]
}