Basic Customer API#

The basic API provides endpoints to search and fetch customer information, and should be used for all use cases except customer administration and management.


Use the Administrative Customer API for customer administration and management.

Fetching a customer#

Fetching a single customer is done using the customer id or shortname

curl -H "Argus-API-Key: my/api/key" -X GET{idOrShortname}

If successful, the above invocation will return the customer basic model:

  "data": {
    "id": 0,
    "name": "string",
    "shortName": "string",
    "domain": {
      "id": 0,
      "name": "string"
    "flags": [
    "type": "GROUP"

All endpoints for fetching, searching/listing, updating and disabling a customer return the same datamodel.

See the Swagger API documentation for details on the returned data model.

Fetching customer user roles#

This endpoint returns a list of customer roles. This endpoint is not yet populated with data.

    curl -H "Argus-API-Key: my/api/key" -X GET "{idOrShortname}

Fetching customer properties#

This endpoint returns a list of properties limited by limit and offset. The list can be filtered by property keys. The list includes default values from the descriptors.

curl -X 'GET' 
-H 'accept: application/json' 
-H 'Argus-API-Key: my/api/key'

Searching for customers#

Searching for customers can be done using the simple search GET endpoint or the advanced search POST endpoint.

Please read the General integration guide to learn about general concepts for search endpoints.


Subcriteria are discussed in detail in the General integration guide. We provide some examples related to the Customer API here, but the concepts for subcriteria are described more in detail there.

Using subcriteria allows you to fetch several different dimensions of data in one query, or express which data to exclude. By default, subqueries will be combined with an “OR” logic.

Subqueries with *exclude=true* define a set of criteria for cases to exclude:

curl -X POST -H "Argus-API-Key: my/api/key" -H "Content-Type: application/json" 
-d  '{
  "subCriteria": [

Listing domains#

This endpoint is located in a separate subsection of the API, called domain. It returns a list of domains limited by limit and offset:

curl -H "Argus-API-Key: my/api/key" -X GET ""