This method is used to get information about customer or get the customers list with the possibility of filtration.

Response Codes

Code

Description

200

All operations were completed. Response returned in JSON format

400

Request parameter is absent or incorrect. For example, wrong email address

404

Customer with specified ID was not found

500

Server error

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: [email protected], [email protected], [email protected]

Filter

Description

Filtration Type

Example

email

Customer's email

Extended

[email protected]

first_name

Customer's first name

Extended

John

last_name

Customer's last name

Extended

Doe

company

Customer's company name

Extended

MacPaw

phone

Customer's phone number

Extended

5554133113

address

Customer's address

Extended

Madison Ave. 11

key

Activation number

Exact

id1234567890123odr

identifier

Identifier of computer, which is connected to the key

Extended

ff:ff:ff:aa:aa:aa

order_id

DevMate order ID

Exact

123456

activation_id

Activation ID (available to customer in application)

Exact

1509013782987

invoice

Billing order ID

Extended

CORP150902-0339-893098

The example above shows the selection of customers by email and last name with the limit of 10 entries.

Response Parameters

Key

Value Type

Description

id

Integer

Customer's ID

email

String

Customer's email

first_name

String

Customer's first name

last_name

String

Customer's last name

company

String

Customer's company name

phone

String

Customer's phone number

address

String

Customer's address

note

String

Notes about customer (can be added in DevMate Dashboard or with API request)

date_added

Integer

Date of adding customer

licenses

Array of objects

Info about licenses. Returned only if info about one customer requested (see description below).

Licenses

Key

Value Type

Description

license_type_name

String

License type name

license_type_id

Integer

License type ID in DevMate

invoice

String

Order ID sent by billing system

campaign

String

Campaign for which the license was issued

date_created

Integer

UTC timestamp of license issued

activations_used

Integer

The number of activations used

id

Integer

The ID of the key in DevMate

expiration_date

Integer

UTC timestamp of the key validity. Applicable if the corresponding option was set in DevMate

products

Array of objects

Products for which the license is valid (see description below)

status

Integer

Activation key status:
1: never used
2: used (application is activated)
3: activation expired
4: blocked within DevMate Dashboard
5: refunded

activations_total

Integer

The number of activations available for customer using the key

activation_key

String

Activation key

history

Array of objects

Activation key changelog (see description below)

Product

Key

Value Type

Description

id

Integer

Product ID in DevMate

name

String

Product name

bundle_id

String

Product bundle ID

use_offline_license

Boolean

Determines whether it is possible to generate offline licenses for the product

History

Key

Value Type

Description

type

Integer

Type of record:
2 – time of license created

user_name

String

DevMate user name, who made an action

note

String

Description of action or comment

timestamp

Integer

UNIX timestamp of time of the action

Language
Authentication
Header
Click Try It! to start a request and see the response here!