Get Program Member Fields

GET /rest/v1/programs/members/schema/fields.json

Permissions Read-Write Schema Standard FieldRead-Write Schema Custom Field

Build a request and mock the response

Method: GET
Path: /rest/v1/programs/members/schema/fields.json
Tag: Program Members
Operation ID: getProgramMemberFieldsUsingGET

Retrieves metadata for all program member fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field

Formats

• Request: application/json
• Response: application/json

Request

Query parameters

Name	Type	Required	Description	Constraints
batchSize	integer (int32)	No	The batch size to return. The max and default value is 300.
nextPageToken	string	No	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Example request

GET {{base_url}}/rest/v1/programs/members/schema/fields.json?batchSize={{batchSize}}&nextPageToken={{nextPageToken}}
Accept: application/json

Responses

200 — OK

Schema: model: ResponseOfLeadField

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "displayName": "Example name",
      "name": "Example name",
      "description": "string",
      "dataType": "string",
      "length": 123,
      "isHidden": false,
      "isHtmlEncodingInEmail": false,
      "isSensitive": false,
      "isCustom": false,
      "isApiCreated": false
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

• ResponseOfLeadField

Source

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.