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

Get Deal By Locator

GET
/v1/deals/by

Returns the requested deal By Locator.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

id?string

Unique identifier for the resource.

Formatuuid
external_id?string

Identifier assigned by an external system.

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/by"
{  "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}