YOyousign
Custom Property

Get a Custom Property

Changed on

Retrieves a specific custom property by its ID. Returns the complete property definition including all options for list types.

get/custom_properties/{customPropertyId}

Request

Path parameters

customPropertyIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Custom Property Id

Response

OK

idstring uuid required

Unique identifier of the custom property.

namestring required

Display name of the property.

type'text' | 'list' required

Field type.

requiredboolean

Whether users must fill this property before sending the SR via the application (not enforced via API).

multiple_answer_allowedboolean nullable

For list type only — whether multiple options can be selected. Null for text type.

workspace_idsUUID[] nullable

List of workspace IDs where this property is applicable. Null means org-wide.

default_valuestring nullable

For text type only — default text pre-filled on new signature requests. Null for list type.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601).

Example response

{
  "workspace_ids": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ]
}

Changes

  • d70860094a83Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status