PRproductive
Deal Statuses

Get deal statuses

Changed on

List deal statuses with optional filters and pagination.

get/api/v2/deal_statuses

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/deal_statuses
  • Auth
    none declared

Query parameters

OR

Filters

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}
sortstring[]

Sort deal status

Response

Collection deal status

Example response

{
  "data": [
    {
      "id": "5",
      "type": "deal_statuses",
      "attributes": {
        "name": "Proposal Sent",
        "position": 3,
        "outcome": "open",
        "color_id": "7"
      },
      "relationships": {
        "pipeline": {
          "data": {
            "type": "pipelines",
            "id": "1"
          }
        }
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter deal status]/status_id/oneOf[subschema #1: Status -> subschema #2: Status]/ of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter deal status]/status_id/oneOf[subschema #2: Operation -> subschema #1: Operation]/contains of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter deal status]/status_id/oneOf[subschema #2: Operation -> subschema #1: Operation]/eq of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter deal status]/status_id/oneOf[subschema #2: Operation -> subschema #1: Operation]/not_contain of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter deal status]/status_id/oneOf[subschema #2: Operation -> subschema #1: Operation]/not_eq of the query request parameter filter

    • breaking

      response property data/items/attributes/color_id list-of-types was widened by adding types null and string to media type application/vnd.api+json of response 200

    • breaking

      the /// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      removed the 4.00 enum value from the /// response property for the response status

    This list may be incomplete.