recurring_grants

List Recurring Grants

Returns a list of all recurring grants for a given Connect. This API allows for paginating over many results.

get/v1/recurring_grants

Query parameters

connect_idstring

the id of the Connect object. This can be used to filter the recurring grants by a specific Connect if you have more than one.

pageLimitinteger

the number of results to return; defaults to 10, max is 100

pageTokenstring

A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response.

Response

The response for RecurringGrants.list

nextPageTokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
      "trackingId": "L9E182VBGP",
      "workflowSessionId": "2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6",
      "fundId": "daf-id",
      "frequency": "MONTHLY",
      "externalRecurringGrantId": "897823sdjf8sfjs",
      "createdAt": "2020-01-31T23:00:00Z",
      "updatedAt": "2020-01-31T23:59:59Z",
      "amount": 15000,
      "firstName": "Warren",
      "lastName": "Buffet",
      "phone": "1237861020",
      "email": "warrenBuffet@example.com",
      "note": "Please dedicate in memory of grandma"
    }
  ]
}

Changes

Changed in 4 of the 43 revisions of this API.20436

  • b87f7738d336820See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • media type application/json was changed to a more specific media type application/problem+json for the response status

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status

      response-media-type-name-specialized

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

  • 90671617b825124See the full diff
    • the response's property type changed from number to string for status

      response-property-type-changed

    • the response's property type changed from number to string for status

      response-property-type-changed

    • the response's property type changed from number to string for status

      response-property-type-changed

    • the response's property type changed from number to string for status

      response-property-type-changed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog