Sign in

d22bb925eeed

latestOpenAPI 3.0.02026-08-062903562.2 MB
Role

listCampaignRoles

Lists all the roles that are available to the Campaign.

get/campaigns/{campaign}/roles

Path parameters

campaigninteger required
Example:227362

The specified Campaign ID

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": [
    {
      "scope_type": "campaign",
      "id": 508,
      "custom_id": "campaign_refund_manager",
      "description": "View transaction details and issue refunds for specific Campaigns. Refunds can be issued from the Transaction History page in your Organization's account.",
      "name": "Campaign Administrator",
      "is_assignable": true,
      "created_at": "2021-04-23T08:23:21Z",
      "updated_at": "2021-04-23T08:23:21Z",
      "classy_live_event_id": 10
    }
  ],
  "first_page_url": "{host}/campaigns/{campaign}/roles?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/campaigns/{campaign}/roles?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/campaigns/{campaign}/roles",
  "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
}