Get Customer(s) Info

This method is used to get information about customer or get the customers list with the possibility of filtration. #Response Codes [block:parameters] { "data": { "h-0": "Code", "h-1": "Description", "0-0": "`200`", "0-1": "All operations were completed. Response returned in JSON format", "1-0": "`400`", "1-1": "Request parameter is absent or incorrect. For example, wrong email address", "2-0": "`404`", "2-1": "Customer with specified ID was not found", "3-0": "`500`", "3-1": "Server error" }, "cols": 2, "rows": 4 } [/block] #Single Customer Info If you want to get the info about specific customer, specify the customer ID in the URL like this (don't forget about your token!): ```` https://public-api.devmate.com/v2/customers/<customer_id> ```` #Get Customers List To get the complete list of customers, send a GET request: ```` https://public-api.devmate.com/v2/customers ```` #Filtration You can get the filtered list of customers. ```` https://public-api.devmate.com/v2/customers?filter[filter1]=value1&filter[filter2]=value2... ```` The following types of filtration are implemented: * **Exact**: only exact matches will be selected. For example, if `order_id=123` was requested, the response will contain the record for customers with order number 123 only, but not 1234 or others. * **Extended**: selects both the exact match and the entries, that contain specified string. For example, if `email=company.com` was requested, the response will contain entries with the following emails: `user@company.com, user@company.com.au, company.com@gmail.com` [block:parameters] { "data": { "h-0": "Filter", "h-1": "Description", "h-2": "Filtration Type", "h-3": "Example", "0-0": "`email`", "1-0": "`first_name`", "2-0": "`last_name`", "6-0": "`key`", "7-0": "`identifier`", "8-0": "`order_id`", "9-0": "`activation_id`", "10-0": "`invoice`", "0-1": "Customer's email", "1-1": "Customer's first name", "2-1": "Customer's last name", "6-1": "Activation number", "7-1": "Identifier of computer, which is connected to the `key`", "8-1": "DevMate order ID", "9-1": "Activation ID (available to customer in application)", "10-1": "Billing order ID", "0-2": "Extended", "1-2": "Extended", "2-2": "Extended", "7-2": "Extended", "10-2": "Extended", "6-2": "Exact", "8-2": "Exact", "9-2": "Exact", "0-3": "user@test.org", "1-3": "John", "2-3": "Doe", "6-3": "id1234567890123odr", "7-3": "ff:ff:ff:aa:aa:aa", "8-3": "123456", "9-3": "1509013782987", "10-3": "CORP150902-0339-893098", "3-0": "`company`", "4-0": "`phone`", "5-0": "`address`", "3-1": "Customer's company name", "4-1": "Customer's phone number", "5-1": "Customer's address", "3-3": "MacPaw", "4-3": "5554133113", "5-3": "Madison Ave. 11", "3-2": "Extended", "4-2": "Extended", "5-2": "Extended" }, "cols": 4, "rows": 11 } [/block] The example above shows the selection of customers by email and last name with the limit of 10 entries. #Response Parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Value Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "0-2": "Customer's ID", "1-0": "`email`", "1-1": "String", "1-2": "Customer's email", "2-0": "`first_name`", "2-1": "String", "2-2": "Customer's first name", "3-0": "`last_name`", "3-1": "String", "3-2": "Customer's last name", "7-0": "`note`", "7-1": "String", "7-2": "Notes about customer (can be added in DevMate Dashboard or with API request)", "8-0": "`date_added`", "8-1": "Integer", "8-2": "Date of adding customer", "9-0": "`licenses`", "9-1": "Array of objects", "9-2": "Info about licenses. Returned only if info about one customer requested (see description below).", "4-0": "`company`", "5-0": "`phone`", "6-0": "`address`", "4-1": "String", "5-1": "String", "6-1": "String", "4-2": "Customer's company name", "5-2": "Customer's phone number", "6-2": "Customer's address" }, "cols": 3, "rows": 10 } [/block] **Licenses** [block:parameters] { "data": { "h-0": "Key", "h-1": "Value Type", "h-2": "Description", "0-0": "`license_type_name`", "0-1": "String", "0-2": "License type name", "1-0": "`license_type_id`", "1-1": "Integer", "1-2": "License type ID in DevMate", "2-0": "`invoice`", "2-1": "String", "2-2": "Order ID sent by billing system", "3-0": "`campaign`", "3-1": "String", "3-2": "Campaign for which the license was issued", "5-0": "`activations_used`", "5-1": "Integer", "5-2": "The number of activations used", "6-0": "`id`", "6-1": "Integer", "6-2": "The ID of the key in DevMate", "7-0": "`expiration_date`", "8-0": "`products`", "9-0": "`status`", "10-0": "`activations_total`", "11-0": "`activation_key`", "12-0": "`history`", "7-1": "Integer", "9-1": "Integer", "10-1": "Integer", "11-1": "String", "12-1": "Array of objects", "8-1": "Array of objects", "7-2": "UTC timestamp of the key validity. Applicable if the corresponding option was set in DevMate", "8-2": "Products for which the license is valid (see description below)", "9-2": "Activation key status:\n1: never used\n2: used (application is activated)\n3: activation expired \n4: blocked within DevMate Dashboard\n5: refunded", "10-2": "The number of activations available for customer using the key", "11-2": "Activation key", "12-2": "Activation key changelog (see description below)", "4-0": "`date_created`", "4-1": "Integer", "4-2": "UTC timestamp of license issued" }, "cols": 3, "rows": 13 } [/block] **Product** [block:parameters] { "data": { "0-0": "`id`", "0-1": "Integer", "0-2": "Product ID in DevMate", "1-0": "`name`", "1-1": "String", "1-2": "Product name", "2-0": "`bundle_id`", "2-1": "String", "2-2": "Product bundle ID", "3-0": "`use_offline_license`", "3-1": "Boolean", "3-2": "Determines whether it is possible to generate offline licenses for the product", "h-0": "Key", "h-1": "Value Type", "h-2": "Description" }, "cols": 3, "rows": 4 } [/block] **History** [block:parameters] { "data": { "0-0": "`type`", "0-1": "Integer", "0-2": "Type of record:\n2 – time of license created", "1-0": "`user_name`", "1-1": "String", "1-2": "DevMate user name, who made an action", "2-0": "`note`", "2-1": "String", "2-2": "Description of action or comment", "3-0": "`timestamp`", "3-1": "Integer", "3-2": "UNIX timestamp of time of the action", "h-0": "Key", "h-1": "Value Type", "h-2": "Description" }, "cols": 3, "rows": 4 } [/block]

Method	{{ tryResults.method }}
Request Headers	{{ tryResults.requestHeaders }}
URL	{{ tryResults.url }}
Request Data	{{ tryResults.data }}
Status
Response Headers	{{ tryResults.responseHeaders }}

DevMate

Get Started: Mac OS Apps

Get Started: Windows Apps

Billing

Track

Improve

Customize

Release Notes

Tips and Tricks

Public API

getGet Customer(s) Info

Definition

Parameters

Path Params

Query Params

Examples

Result Format

Documentation

User Information

Try It Out