Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Designation

listOrganizationDesignations

Retrieves a list of all Designations related to the specified Organization

get/organizations/{organization}/designations

Path parameters

organizationinteger required
Example:82364

The specified Organization ID

Query parameters

fields'city' | 'created_at' | 'description' | 'end_time' | 'external_reference_id' | 'goal' | 'id' | 'is_active' | 'is_complete' | 'is_default' | 'name' | 'organization_id' | 'postal_code' | 'start_time' | 'state' | 'updated_at'
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": [
    {
      "city": "San Diego",
      "created_at": "2021-04-23T08:23:21Z",
      "description": "My Designation Description",
      "end_time": "2021-04-23 08:23:21",
      "external_reference_id": "my_unique_identifier",
      "goal": "1000.0",
      "id": 34672,
      "is_active": true,
      "name": "My Designation Name",
      "organization_id": 82364,
      "postal_code": "90210",
      "start_time": "2021-04-23 08:23:21",
      "state": "CA",
      "updated_at": "2021-04-23T10:25:03Z"
    }
  ],
  "first_page_url": "{host}/organizations/82364/designations?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "{host}/organizations/82364/designations?page=1",
  "next_page_url": "https://pro.gofundme.com/api/2.0/resource?page=2",
  "path": "{host}/organizations/82364/designations",
  "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
}