v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Custom Properties

Retrieve all custom properties

Retrieve all custom properties.

Required scopes: flex.settings.customProperties.read

get/api/v2/organizations/{orgSlug}/custom-properties

Path parameters

orgSlugstring required

organization slug

Query parameters

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "6a59d080856fad4ee41952fa",
      "key": "CProp",
      "title": "My Custom Property",
      "placeholder": "Placeholder Value",
      "type": "String",
      "privacy": "admin",
      "targets": [
        "member",
        "contract",
        "plan-fee"
      ],
      "values": [
        "Value1",
        "Value2"
      ],
      "rates": [
        "6a59d080856fad4ee41952fb",
        "6a59d080856fad4ee41952fc"
      ]
    }
  ]
}