Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Deals

List Deals

GET
/v1/deals

Returns a paginated list of deals.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

contact?string

Filters resources by contact.

contact[in]?string

Filters by any of the supplied contact values.

external_id?string

Identifier assigned by an external system.

external_id[in]?string

Filters by any of the supplied external id values.

status_key?string

Filters resources by status key.

status_key[in]?string

Filters by any of the supplied status key values.

type_key?string

Filters resources by type key.

type_key[in]?string

Filters by any of the supplied type key values.

assignee?string

Filters resources by assignee.

assignee[in]?string

Filters by any of the supplied assignee values.

assignee[is_null]?true

Filters for resources where assignee is null.

assignee[not_null]?true

Filters for resources where assignee is not null.

value?string

Filters resources by value.

value[gt]?string

Filters resources by value using the gt operator.

value[gte]?string

Filters resources by value using the gte operator.

value[lt]?string

Filters resources by value using the lt operator.

value[lte]?string

Filters resources by value using the lte operator.

limit?integer

Maximum number of resources to return.

Default10
Range0 <= value <= 100
page_token?string

Opaque token returned by a previous page request.

Length1 <= length
include?array<"contact" | "status" | "assignee">

Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar.

include_details?array<string>

Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar.

Itemsitems <= 10

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/deals"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "external_id": "string",      "name": "string",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",      "type_key": "string",      "status_key": "string",      "value": 0,      "currency": "CHF",      "won_at": "2019-08-24T14:15:22Z",      "lost_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "contact": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "display_name": "string",        "full_name": "string",        "salutation": "string",        "birthday": "2019-08-24T14:15:22Z",        "description": "string",        "external_id": "string",        "secondary_external_id": "string",        "address_line1": "string",        "address_line2": "string",        "city": "string",        "zipcode": "string",        "country": "string",        "is_blocked": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "status": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "key": "string",        "name": "string",        "type": "in_progress",        "idx": 9007199254740991      },      "assignee": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "username": "string",        "full_name": "string",        "email": "string",        "locale": "string",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "property1": null,      "property2": null    }  ],  "next_page_url": "string",  "previous_page_url": "string"}