Get Deals | Moyo Suite Developer Platform

{
  "items": [
    {
      "title": "string",
      "account_id": "string",
      "id": "string",
      "tenant_id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "value": "0.00",
      "currency": "USD",
      "stage": "new",
      "close_date": "2023-01-15",
      "probability": 1,
      "assigned_to": "string",
      "notes": "string",
      "custom_data": {},
      "contact_id": "string",
      "pipeline_stage_id": "string",
      "pipeline_stage_name": "string",
      "pipeline_stage_color": "string",
      "is_won": false,
      "is_lost": false,
      "account_name": "string",
      "contact_name": "string",
      "assignee_name": "string",
      "assignee_email": "string"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 1,
  "pages": 1
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional1-100Defaults to 20

searchstring or nullOptional<=200 characters

stagelist of strings or nullOptional

Repeatable; matches any of the given stages

assigned_tostring or nullOptionalformat: "uuid"

unassignedbooleanOptionalDefaults to false

minebooleanOptionalDefaults to false

Shorthand for assigned_to=<current user>

sort_bystring or nullOptional<=50 characters

Field to sort by; see the resource’s sortable fields

sort_dirstring or nullOptionalformat: "^(asc|desc)$"

Response

Successful Response

itemslist of objects

totalinteger

pageinteger

sizeinteger

pagesintegerRead-only

Errors

422

Unprocessable Entity Error