Apideck · Schema

OpportunitiesSort

IntegrationsUnified API

Properties

Name	Type	Description
by	string	The field on which to sort the Opportunities
direction	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OpportunitiesSort",
  "title": "OpportunitiesSort",
  "type": "object",
  "x-apideck-schema-id": "OpportunitiesSort",
  "example": {
    "by": "created_at",
    "direction": "desc"
  },
  "properties": {
    "by": {
      "type": "string",
      "x-apideck-enum-id": "opportunities.sort_by",
      "description": "The field on which to sort the Opportunities",
      "enum": [
        "created_at",
        "updated_at",
        "title",
        "win_probability",
        "monetary_amount",
        "status"
      ],
      "example": "created_at"
    },
    "direction": {
      "$ref": "#/components/schemas/SortDirection"
    }
  },
  "additionalProperties": false
}