Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designation groups

Get a designation group

This request lets you retrieve a single designation group from your Fundraise Up account. A designation group is a container for related designations and other designation groups.

get/v1/designation_groups/{id}

Path parameters

idstring required
Example:LXXXXXXX

Unique identifier of the designation group, formatted as L[A-Z\d]{7}.

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.

Response

On success, the API returns the designation group object. If the provided identifier is invalid or no matching group exists for the current account, the request returns an error.

idstring required

Unique identifier of the designation group.

namestring required

Designation group name.

Example response

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