Get a custom field value
get
/learn.rest/v1/memberships/{membershipId}/customerFieldValues/{customFieldValueId}
Request
Path Parameters
-
customFieldValueId: number
Unique identifier of custom field.
-
membershipId: number
Unique identifier of Membership.
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
200 Response
Custom field fetched.
Root Schema : CustomFieldValueResponse
Type:
object
Response object for the custom field.
Show Source
-
customField(optional):
object customField
Custom Field object comprising the links to Custom field values.
-
customFieldId(optional):
number
Custom field unique identifier.Example:
407
-
id(optional):
number
Membership unique identifier.Example:
519652
-
links(optional):
array links
Custom Field Value Links.
-
value(optional):
string
Custom field values.Example:
JCK
Example:
{
"application/json":{
"id":"1",
"customFieldId":"456",
"customField":{
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenters/123/userCustomFields/456"
}
]
},
"value":"User Custom Field Value",
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenters/456/userCustomFields/1"
}
]
}
}
Nested Schema : customField
Type:
object
Custom Field object comprising the links to Custom field values.
Show Source
Nested Schema : links
Type:
array
Custom Field Value Links.
Show Source
-
Array of:
object CustomFieldValueLinkItems
Custom Field Value Link Object. This object comprises links to the custom field values.
Nested Schema : links
Type:
Show Source
array
-
Array of:
object CustomFieldValueLinkItems
Custom Field Value Link Object. This object comprises links to the custom field values.
Nested Schema : CustomFieldValueLinkItems
Type:
object
Custom Field Value Link Object. This object comprises links to the custom field values.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/memberships/178418/customFieldValues/456
-
rel(optional):
string
Example:
canonical
401 Response
Authentication refused for provided credentials or the token is invalid.
Headers
404 Response
Resource not found.
500 Response
Internal server error.