Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Question

listCampaignQuestions

Retrieves a list of all questions for a specific Campaign. Questions marked as is_required: true will be treated as pre-conversion (shown before donation), and those marked as is_required: false will be treated as post-conversion (shown after donation) only where supported.

get/campaigns/{campaign}/questions

Path parameters

campaigninteger required
Example:227362

The specified Campaign ID

Query parameters

fields'campaign_id' | 'created_at' | 'deleted_at' | 'enum_options' | 'id' | 'is_required' | 'is_deleted' | 'label' | 'location' | 'tag' | 'type' | 'updated_at' | 'weight' | 'product_id'
Example:id

Comma-separated list of fields to be returned

pageinteger
Example:1

Indicator of which page of results to return

per_pageinteger
Example:20

Number of entries to return in each page of results

Response

Success

current_pageinteger

Index of current page

first_page_urlstring nullable

URL of first page of results

frominteger nullable

Index of first displayed result within total result set

last_pageinteger

Index of last page in result set

last_page_urlstring nullable

URL of last page of results

next_page_urlstring nullable

URL of next page of results

pathstring nullable

URL of current page of results

per_pageinteger

Maximum number of records returned per page of results

prev_page_urlstring nullable

URL of previous page of results

tointeger nullable

Index of last displayed result within total result set

totalinteger

Total count of records in result set

Example response

{
  "current_page": 1,
  "data": [
    {
      "campaign_id": 227362,
      "created_at": "2021-04-23T10:25:03Z",
      "deleted_at": "2021-04-23T10:25:03Z",
      "id": 45678,
      "is_required": true,
      "label": "Do you require accommodations due to a medical condition or disability?",
      "location": "donation_page",
      "product_id": 73647,
      "tag": "email_address",
      "type": "boolean",
      "updated_at": "2021-04-23T10:25:03Z"
    }
  ],
  "first_page_url": "{host}/campaigns/{campaign}/questions?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/campaigns/{campaign}/questions?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/campaigns/{campaign_id}/questions",
  "per_page": 20,
  "prev_page_url": "https://pro.gofundme.com/api/2.0/resource?page=1",
  "links": [
    {
      "label": "1",
      "url": "{host}/{resource}?page=1",
      "active": true
    }
  ],
  "to": 1,
  "total": 1
}