Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Custom field fetched.

Body ()

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

{
    "description":"Response object for the custom field.",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":519652,
            "description":"Membership unique identifier."
        },
        "customFieldId":{
            "type":"number",
            "example":407,
            "description":"Custom field unique identifier."
        },
        "customField":{
            "type":"object",
            "description":"Custom Field object comprising the links to Custom field values.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CustomFieldValueLinkItems"
                    }
                }
            }
        },
        "value":{
            "type":"string",
            "example":"JCK",
            "description":"Custom field values."
        },
        "links":{
            "description":"Custom Field Value Links.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CustomFieldValueLinkItems"
            }
        }
    },
    "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"
                }
            ]
        }
    }
}

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

• links(optional): array links

{
    "type":"object",
    "description":"Custom Field object comprising the links to Custom field values.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CustomFieldValueLinkItems"
            }
        }
    }
}

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.

{
    "description":"Custom Field Value Links.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CustomFieldValueLinkItems"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object CustomFieldValueLinkItems
  Custom Field Value Link Object. This object comprises links to the custom field values.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CustomFieldValueLinkItems"
    }
}

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

{
    "type":"object",
    "description":"Custom Field Value Link Object. This object comprises links to the custom field values.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/memberships/178418/customFieldValues/456"
        }
    }
}

401 Response

Authentication refused for provided credentials or the token is invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

500 Response

Internal server error.

Back to Top