Get a list of custom field values
get
/learn.rest/v1/memberships/{membershipId}/customFieldValues
Request
Path Parameters
-
membershipId: number
Unique identifier of a Membership.
Query Parameters
-
limit(optional): integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify starting point of the response.Default Value:
0 -
totalResults(optional): boolean
If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.
Security
-
auth: basic
Type:
basicDescription:Basic Authentication
Response
Supported Media Types
- application/json
200 Response
Custom field values collection fetched.
Example Response (application/json)
{
"items":[
{
"id":509614,
"customFieldId":67,
"customField":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178418/userCustomFields/67"
}
]
},
"value":"JK",
"links":[
{
"rel":"canonical",
"href":"https://{url}}m/learn.rest/v1/memberships/1234/customFieldValues/509614"
}
]
},
{
"...":null
}
],
"totalResults":1200,
"limit":100,
"count":100,
"hasMore":true,
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/collectionName"
},
{
"rel":"first",
"href":"{url}/v1/collectionName?limit=100&offset=0"
},
{
"rel":"prev",
"href":"{url}/learn.rest/v1/collectionName?limit=100&offset=0"
},
{
"rel":"next",
"href":"{url}/learn.rest/v1/collectionName?limit=100&offset=10"
},
{
"rel":"last",
"href":"{url}/learn.rest/v1/collectionName?limit=100&offset=1200"
}
]
}401 Response
Authentication refused for provided credentials or the token is invalid.
Headers
500 Response
Internal server error.