Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designation groups

Get designation groups

Use this request to retrieve a paginated list of designation groups from your Fundraise Up account. A designation group is a container for related designations and other designation groups.

get/v1/designation_groups

Query parameters

livemodeboolean
Example:true

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Designation groups only exist in live mode — set this to true.

starting_afterstring

A cursor for pagination. Returns records older than the specified object ID.

ending_beforestring

A cursor for pagination. Returns records newer than the specified object ID.

limitinteger

This parameter specifies the number of records to display per page, ranging from 1 to 100

created[gt]string date-time

Minimum creation date (exclusive). Returns records after this timestamp.

created[gte]string date-time

Minimum creation date (inclusive). Returns records from and after this timestamp.

created[lt]string date-time

Maximum creation date (exclusive). Returns records before this timestamp.

created[lte]string date-time

Maximum creation date (inclusive). Returns records up to and including this timestamp.

Filters results by the record creation date. Accepts a single date or a date range in RFC 3339 format.

{
  "created[gt]": "2025-01-01T12:30:00+02:00",
  "created[gte]": "2025-01-01T12:30:00+02:00",
  "created[lt]": "2025-01-01T12:30:00+02:00",
  "created[lte]": "2025-01-01T12:30:00+02:00"
}
designationstring
Example:EXXXXXXX

The ID of the designation to filter by. Returns groups containing the specified designation.

Response

On success, the API returns a list of designation groups. The response includes an array of designation group objects and a boolean indicating whether more records are available.

has_moreboolean required

Indicates whether there are more records available. For starting_after, it shows that there is a page with older records. For ending_before, it indicates that there is a page with newer records.

Example response

{
  "data": [
    {
      "children": [
        {
          "code": "SCH-01",
          "id": "EXXXXXXX",
          "name": "Scholarship Fund",
          "type": "designation"
        }
      ],
      "id": "LXXXXXXX",
      "name": "Education Programs"
    }
  ],
  "has_more": true
}