Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Ticket Type

listCampaignTicketTypes

Get Ticket Types for a given Campaign.

get/campaigns/{campaign}/ticket-types

Path parameters

campaigninteger required
Example:227362

Primary identifier of Campaign

Query parameters

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": [
    {
      "commitment": {
        "deadline": "2016-02-01T00:00:00+0000",
        "value": 100
      },
      "description": "Ticket Type description",
      "ended_at": "2019-04-23T10:25:03Z",
      "entries_per_ticket": 3,
      "is_active": true,
      "max_per_transaction": 1,
      "name": "General Admission",
      "org_percent": 100,
      "deductible_amount": 5,
      "deductible_percent": 100,
      "price": 10,
      "quantity_available": 2,
      "started_at": "2016-01-01T12:00:00+0000",
      "weight": 1,
      "campaign_id": 227362,
      "commitment_id": 98374,
      "created_at": "2016-01-01T12:00:00+0000",
      "id": 9978,
      "min_per_transaction": 1,
      "quantity_reserved": 1,
      "quantity_sold": 1,
      "updated_at": "2016-01-01T12:00:00+0000"
    }
  ],
  "first_page_url": "{host}/campaigns/{campaign}/ticket-types?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/campaigns/{campaign}/ticket-types?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/campaigns/{campaign}/ticket-types",
  "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
}