OFofficernd
Custom Properties

Retrieve all custom properties

Retrieve all custom properties.

Required scopes: flex.settings.customProperties.read

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

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/custom-properties
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.settings.customProperties.read

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": "6ae88421c1df3a98369079b6",
      "key": "CProp",
      "title": "My Custom Property",
      "placeholder": "Placeholder Value",
      "type": "String",
      "privacy": "admin",
      "targets": [
        "member",
        "contract",
        "plan-fee"
      ],
      "values": [
        "Value1",
        "Value2"
      ],
      "rates": [
        "6ae88421c1df3a98369079b7",
        "6ae88421c1df3a98369079b8"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.