v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Organization Channel

listOrganizationChannel

Retrieves a list of all Channels for the specified Organization

get/organizations/{organization}/channels

Path parameters

organizationinteger required
Example:82364

Primary identifier of Organization

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

{host}/organizations/82364/channels?page=1

next_page_urlstring nullable

URL of next page of results

pathstring nullable

{host}/organizations/82364/channels

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": [
    {
      "additional_configurations": [
        "DoubleTheDonation"
      ],
      "channel_name": "Facebook",
      "channel_integration_details_id": 101,
      "id": 2437,
      "organization_id": 82364,
      "status": "disabled",
      "step_statuses": {
        "authorize_granted": true,
        "granted_fundraiser_permission": true
      }
    }
  ],
  "first_page_url": "{host}/organizations/82364/channels?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://pro.gofundme.com/api/2.0/resource?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "https://pro.gofundme.com/api/2.0/resource",
  "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
}