CRM

Retrieve all deals.

Returns the deals associated with your account.

get/api/v1/crm/deals

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/crm/deals
Auth: one of:
- HTTP bearer
- API key in header Authorization

Query parameters

ownerUidstring nullable

Uid of the owner of the deal, or -1 for unassigned deals and -2 for all assigned deals.

qstring nullable

Match on the deal name, the pipeline stage name, or the account name.

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "Name": "string",
      "Amount": 0,
      "DueDate": "string",
      "AssignedToPersonClientIdentifier": "string",
      "Weight": 0,
      "DealPipelineStage": {},
      "Account": {},
      "DealPeople": [],
      "Contacts": "string",
      "AccountId": 0,
      "Owner": {},
      "PipelineUid": "string"
    }
  ]
}

Changes

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