Supporters

Actions available on supporters.

List

Retrieve a list of matching supporters.

Request

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

  • filters: (how?)

    • name: optional, string, partial match
    • email: optional, string, partial match
    • recurringProfile: optional, string, value of : active, suspended, cancelled or expired

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",
      "groups": [
        {
          "id": "P59EKZDK",
          "group_id": "7GZEJPE2",
          "name": "Voluptatem est",
          "start_date": "2019-04-29",
          "end_date": "2024-04-28",
          "is_active": true,
          "is_expired": false,
          "days_left": 675,
          "related": [
              {
                  "id": "P59EKZDK",
                  "name": "Voluptatem est",
                  "start_date": "2019-04-29",
                  "end_date": "2022-04-29",
                  "is_active": false,
                  "is_expired": true,
                  "source": "manual",
                  "end_reason": null,
                  "days_left": 0
              },
              {
                  "id": "KJLEMLD8",
                  "name": "Voluptatem est",
                  "start_date": "2022-04-29",
                  "end_date": "2023-04-29",
                  "is_active": true,
                  "is_expired": false,
                  "source": "manual",
                  "end_reason": null,
                  "days_left": 310
              },
              {
                  "id": "NP7EN4EG",
                  "name": "Voluptatem est",
                  "start_date": "2023-04-29",
                  "end_date": "2024-04-28",
                  "is_active": false,
                  "is_expired": false,
                  "source": "manual",
                  "end_reason": null,
                  "days_left": 675
              }
          ]
        }
      ]
    },
    {
      "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",
      "groups": [
        {
          "id": "P59EKZDK",
          "name": "Voluptatem est",
          "start_date": "2019-04-29",
          "end_date": "2022-04-29",
          "is_active": false,
          "is_expired": true,
          "days_left": 0,
          "related": [
              {
                  "id": "P59EKZDK",
                  "name": "Voluptatem est",
                  "start_date": "2019-04-29",
                  "end_date": "2022-04-29",
                  "is_active": false,
                  "is_expired": true,
                  "source": "manual",
                  "end_reason": null,
                  "days_left": 0
              }
          ]
        }
      ]
    },
    {
      "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",
      "groups": []      
    }
  ],
  "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: required, 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",
  "groups": [
    {
      "id": "P59EKZDK",
      "group_id": "7GZEJPE2",
      "name": "Voluptatem est",
      "start_date": "2019-04-29",
      "end_date": "2024-04-28",
      "is_active": true,
      "is_expired": false,
      "days_left": 675,
      "related": [
          {
              "id": "P59EKZDK",
              "name": "Voluptatem est",
              "start_date": "2019-04-29",
              "end_date": "2022-04-29",
              "is_active": false,
              "is_expired": true,
              "source": "manual",
              "end_reason": null,
              "days_left": 0
          },
          {
              "id": "KJLEMLD8",
              "name": "Voluptatem est",
              "start_date": "2022-04-29",
              "end_date": "2023-04-29",
              "is_active": true,
              "is_expired": false,
              "source": "manual",
              "end_reason": null,
              "days_left": 310
          },
          {
              "id": "NP7EN4EG",
              "name": "Voluptatem est",
              "start_date": "2023-04-29",
              "end_date": "2024-04-28",
              "is_active": false,
              "is_expired": false,
              "source": "manual",
              "end_reason": null,
              "days_left": 675
          }
      ]
    }
  ]  
}