Referral Form Configuration List

Output representation of a paginated list of referral form configuration records that match the request filters, along with metadata and the overall API response status.

JSON Example

1{
2  "success": true,
3  "httpStatus": 200,
4  "totalRecords": 2,
5  "nextPageToken": null,
6  "definitions": [
7    {
8      "id": "a0X5g000000ABcD",
9      "name": "Standard Inbound Referral",
10      "description": "Default form for inbound referrals",
11      "isActive": true,
12      "createdDate": "2026-01-15T10:30:00Z",
13      "lastModifiedDate": "2026-02-20T14:45:00Z"
14    },
15    {
16      "id": "a0X5g000000EFgH",
17      "name": "Outbound Partner Referral",
18      "description": null,
19      "isActive": false,
20      "createdDate": "2026-03-01T08:00:00Z",
21      "lastModifiedDate": "2026-03-01T08:00:00Z"
22    }
23  ]
24}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`definitions`	Referral Form Configuration[]	List of referral form configuration records that match the request filters, with the details of each configuration.	Big, 67.0	67.0
`httpStatus`	Integer	HTTP status code that the API returns for the request.	Big, 67.0	67.0
`nextPageToken`	String	Opaque token that identifies the next page of results. Pass this value on the next request to continue paging. The value is `null` when there are no more records to return.	Big, 67.0	67.0
`success`	Boolean	Indicates whether the referral form configuration records are retrieved successfully (`true`) or not (`false`).	Big, 67.0	67.0
`totalRecords`	Integer	Total number of referral form configuration records returned in the `definitions` list.	Big, 67.0	67.0