Get Custom Fields

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2025-01-01.

It is scheduled for sunset on 2027-01-31.

Description

Retrieve the list of Custom Fields defined on a Record Type. Returns Active fields by default, unless desired states are optionally-provided. This endpoint is deprecated, please use the customSchema endpoint instead.

GET /prototype/platform/recordTypes/{recordType}/customFields

Required OAuth Scopes

No OAuth scopes are required to use this endpoint.

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
$filter	query	string	false	The properties to filter the results by.
$orderBy	query	string	false	One or more comma-separated expressions to indicate the order in which to sort the results.
$maxpagesize	query	integer	false	The maximum number of results to retrieve
$next	query	string	false	Pagination cursor for next set of results.
recordType	path	string	true	The Record Type upon which to operate

Enumerated Values

Parameter	Value
recordType	Document
recordType	Presentation
recordType	Spreadsheet
recordType	Section
recordType	Slide
recordType	Sheet

Filter Options

Name	Predicates Supported
schema.state	eq, in

Code Samples

curl

curl -X GET https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/prototype/platform/recordTypes/{recordType}/customFields', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of CustomField objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

400 - Bad Request

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses

200 Response

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "com.workiva.gsr.legal_entity",
      "schema": {
        "description": "string",
        "enum": [
          null
        ],
        "format": "date-time",
        "maxLength": 0,
        "maximum": 0,
        "minLength": 0,
        "minimum": 0,
        "pattern": "/regex/",
        "reference": {
          "$comment": "string",
          "cardinality": "one",
          "description": "string",
          "field": "/json/pointer",
          "referenceType": "ReadCache",
          "resource": "Document"
        },
        "rhp_position_hint": 0,
        "state": "Draft",
        "title": "string",
        "type": "boolean"
      }
    }
  ]
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}