Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designations

Get designations

This request lets you retrieve a paginated list of designations from your Fundraise Up account, including designations inherited from the parent account.

get/v1/designations

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. Designations 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"
}
campaignstring

The ID of the campaign to filter by. Returns designations assigned to the specified campaign.

Response

On success, the API returns the array of designation objects. If the parameters are invalid, the call will return an error.

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": [
    {
      "account": {
        "code": "Code-1",
        "id": "AXXXXXXX",
        "name": "Example Account"
      },
      "code": "Code-1",
      "created_at": "2024-01-01T00:00:00.000Z",
      "id": "EXXXXXXX",
      "is_default": true,
      "name": "My Designation",
      "updated_at": "2024-01-31T00:00:00.000Z"
    }
  ],
  "has_more": true
}