MetroLeads Developer Docs

Companies

You can get more details about Company data structure from here

Queries

Lead Fields

Get company lead fields meta data

Resource URL

GET /companies/<company_uuid>/lead_settings/fields

Example Request

curl "https://api.metroleads.com/companies/74dc3d24-7d56-453c-9c9f-fd2ca8e77237/lead_settings/fields"

Example Response

[
  {
    "sub_fields": [
      {
        "sortable": false,
        "name": "line_1_ef92339f",
        "summary": false,
        "field_facet": false,
        "print_lines": 1,
        "label": "Line 1",
        "type": "text"
      },
      {
        "sortable": false,
        "name": "zip_code_ab9330bc",
        "summary": false,
        "field_facet": false,
        "print_lines": 1,
        "label": "Zip Code",
        "type": "number"
      },
      {
        "sortable": false,
        "name": "city_90b58bbc",
        "summary": false,
        "field_facet": false,
        "choices": [
          "London",
          "Paris"
        ],
        "print_lines": 1,
        "label": "City",
        "type": "dropdown"
      }
    ],
    "cardinality": 1,
    "sortable": false,
    "name": "address_e879c412",
    "label": "Address",
    "field_facet": false,
    "pinned": false,
    "print_lines": 1,
    "field_group": "",
    "type": "complex"
  }
]

States

List all states in the company

Resource URL

GET /companies/<company_uuid>/lead_settings/states

Example Request

curl "https://api.metroleads.com/companies/9eaba815-1f7f-433b-a7f5-affd3d9460e3/lead_settings/states"

Example Response

[
  {
    "color": "#dc2127",
    "name": "opportunities",
    "label": "Opportunities"
  },
  {
    "color": "#5484ed",
    "name": "contacted",
    "label": "Contacted"
  },
  {
    "color": "#ffb878",
    "name": "presentation",
    "label": "Presentation"
  },
  {
    "color": "#7ae7bf",
    "name": "samples",
    "label": "Samples"
  },
  {
    "color": "#ff887c",
    "name": "pricing_discussion",
    "label": "Pricing Discussion"
  },
  {
    "color": "#7bd148",
    "name": "event_confirmed",
    "label": "Event Confirmed"
  },
  {
    "color": "#5484ed",
    "name": "offer",
    "label": "Offer"
  },
  {
    "color": "#7bd148",
    "name": "contract_signed",
    "label": "Contract Signed"
  },
  {
    "color": "#dbadff",
    "name": "order_placed",
    "label": "Order Placed"
  },
  {
    "color": "#dbadff",
    "name": "delivery_date_set",
    "label": "Delivery Date Set"
  },
  {
    "color": "#46d6db",
    "name": "in_process",
    "label": "In Process"
  },
  {
    "color": "#dc2127",
    "name": "air_shipment_request",
    "label": "Air Shipment Request"
  },
  {
    "color": "#fbd75b",
    "name": "complete_pending",
    "label": "Complete/Pending"
  },
  {
    "color": "#dc2127",
    "name": "closed_lost",
    "label": "Closed Lost"
  },
  {
    "color": "#e1e1e1",
    "name": "dormant",
    "label": "Dormant"
  }
]

Groups

List all user groups in the company

Resource URL

GET /companies/<company_uuid>/lead_settings/groups

Example Request

curl "https://api.metroleads.com/companies/9eaba815-1f7f-433b-a7f5-affd3d9460e3/lead_settings/groups"

Example Response

[
  {
    "deletable": false,
    "id": "ae17d402-cdc3-4194-945a-1d4a49d5787b",
    "smart_view_id": "320f7fc4-58e4-4689-84de-efaa041f8d2c",
    "label": "Family & Friends"
  },
  {
    "deletable": false,
    "id": "d0260355-1760-4c96-982e-733536d5fae5",
    "smart_view_id": "c0a86fad-c43d-4d80-bea2-ecb8e44ed700",
    "label": "Vendor"
  },
  {
    "deletable": false,
    "id": "4e35fc72-0276-4646-80fd-8435b09a48e0",
    "smart_view_id": "a8579a84-8b31-4b68-b3c1-3161a986c499",
    "label": "Customers"
  },
  {
    "deletable": false,
    "id": "dffdbbd2-9c34-4c17-b496-750224d571e0",
    "smart_view_id": "553a27f0-642c-4001-bf25-0ea0e0bed730",
    "label": "Telemarketers"
  },
  {
    "id": "5636140f-2ecd-44da-838f-be860d516f31",
    "deletable": false,
    "label": "Leads"
  },
  {
    "deletable": false,
    "id": "c77a257c-80d6-4d73-9a6d-1e182773bae7",
    "smart_view_id": "2f30341c-d99d-43ba-87aa-35f9b9441782",
    "label": "Households"
  }
]

Currencies

List currency options set by the administrator. Currency rates are updated once every 6 hours and every client must refresh periodically.

Resource URL

GET /companies/<company_uuid>/lead_settings/currencies

Example Request

curl "https://api.metroleads.com/companies/9eaba815-1f7f-433b-a7f5-affd3d9460e3/lead_settings/currencies"

Example Response

{
  "currencies": [
    {
      "name": "United States Dollar",
      "show": true,
      "company_default": false,
      "symbol": "&#36;",
      "rate": 1,
      "unit": "USD"
    },
    {
      "name": "Euro",
      "show": true,
      "company_default": false,
      "symbol": "&#128;",
      "rate": 0.934785,
      "unit": "EUR"
    },
    {
      "name": "Bitcoin",
      "show": true,
      "company_default": false,
      "symbol": "BTC",
      "rate": 0.0010859811,
      "unit": "BTC"
    },
    {
      "name": "Indian Rupee",
      "show": true,
      "company_default": false,
      "symbol": "&#x20B9;",
      "rate": 68.1067,
      "unit": "INR"
    },
    {
      "name": "British Pound Sterling",
      "show": true,
      "company_default": false,
      "symbol": "&#163;",
      "rate": 0.7968759999999999,
      "unit": "GBP"
    },
    {
      "name": "Thai Baht",
      "show": true,
      "company_default": false,
      "symbol": "THB",
      "rate": 35.2465,
      "unit": "THB"
    },
    {
      "name": "Aruban Florin",
      "show": true,
      "company_default": false,
      "symbol": "AWG",
      "rate": 1.799996,
      "unit": "AWG"
    },
    {
      "name": "Angolan Kwanza",
      "show": true,
      "company_default": false,
      "symbol": "AOA",
      "rate": 165.9065,
      "unit": "AOA"
    },
    {
      "name": "Afghan Afghani",
      "show": true,
      "company_default": false,
      "symbol": "AFN",
      "rate": 66.781,
      "unit": "AFN"
    },
    {
      "name": "Algerian Dinar",
      "show": true,
      "company_default": false,
      "symbol": "DZD",
      "rate": 109.535,
      "unit": "DZD"
    },
    {
      "name": "Jersey Pound",
      "show": true,
      "company_default": false,
      "symbol": "JEP",
      "rate": 0.7968759999999999,
      "unit": "JEP"
    }
  ]
}