Dev logo
API Walkthrough
Resources

Show all payment requests

Show all payment requests for the given umbrella, limited by the given query parameters.

Request

Parameters

Field Label Type Description Required?
key string a valid API Key for your community required
umbrella_id integer the umbrella to for these treasury requests required
page integer the page to retrieve (only with per_page, defaults to all) recommended
per_page integer the number of entries per page (only with page, defaults to all) recommended
status string the status of the request optional
type string the type of the request optional
period_id integer limit results to only the given budget period id optional
completed boolean filter by whether the request is completed optional

Returns

Field Label Type Description
approved_total float the total approved amount
budget_period hash the budget period for this entry (id, name)
form_submission hash the optional form submission for this entry
id integer the id of this entry
major_line_items array of hashes the major line items for this entry
name string the name of this entry
portal hash the portal for this entry (including id, name, and more)
requested_total float the total requested amount
status string the status of the request
submitted_at datetime the time this entry was submitted
type string the type of the request
account hash some account information
decided_at datetime the time this entry was decided
completed_at datetime the time this entry was completed
completed_by hash account who completed the request

Sample Request

Sample Return