Get accounts

  • 1 minute(s) read
Prev Next
Get
/accounts

Retrieve a list of accounts in the system.

Security
HTTP
Type bearer

OAuth access token. For details, read Obtain or refresh an OAuth token.

Query parameters
limit
integer

Defines the maximum number of records to return.

Example10
offset
integer

Defines the number of records to skip.

Default0
filter
string

Filter criteria. If a keyword contains a space, enclose it in apostrophes ('). If the keyword is a URI, URL-encode it.

sort
string

Defines the sort order of the result. Use 'ASC' for ascending order and 'DESC' for descending order. The default sort order is objectName ASC.

Default"objectName ASC"
ExampleobjectName ASC
resolveRelations
string

Resolves nested data. Supports multiple values in a comma-separated format.

ExampleincludesAddress, usesMainAddress, containsContact
Responses
200

Returns the list of accounts with 'includesAddress' resolved.

[
  {
    "id": "aHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BY2NvdW50I2UxNGYxMjQ0ZTJlNzRiM2E5YzM4OTY3MDZiYjFlNWRi=-",
    "type": "Account",
    "uri": "http://localhost:8080/iss/Account#e14f1244e2e74b3a9c3896706bb1e5db",
    "objectName": "Account1",
    "objectId": "e14f1244e2e74b3a9c3896706bb1e5db",
    "objectDateOfCreation": 1594608096026,
    "objectDateOfUpdate": 1594613347878,
    "accountOpportunityVolume": 0,
    "accountProspect": true,
    "accountQuoteCount": 0,
    "accountQuoteVolume": 0,
    "hasIndustry": [
      {
        "id": "aHR0cDovL3d3dy5pbm1pbmRjbG91ZC5kZXYuY29tL2FwcGxpY2F0aW9uL2FwcGxpY2F0aW9uLWltcGxlbWVudGF0aW9uLm93bCNJSG90ZWw",
        "uri": "http://www.inmindcloud.dev.com/application/application-implementation.owl#IHotel"
      }
    ],
    "includesAddress": [
      {
        "id": "aHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BZGRyZXNzIzU0MzQ5N2FiZDliNTQ2NzJiYTI4YzAxZmIyZmQyYTQ5",
        "type": "Address",
        "uri": "http://localhost:8080/iss/Address#543497abd9b54672ba28c01fb2fd2a49",
        "objectId": "543497abd9b54672ba28c01fb2fd2a49"
      }
    ],
    "usesMainAddress": [
      "http://localhost:8080/iss/Address#543497abd9b54672ba28c01fb2fd2a49"
    ],
    "containsContact": [
      "http://localhost:8080/iss/Contact#df47473418c2442ab0d7e59d0125c2a5",
      "http://localhost:8080/iss/Contact#366031fb0a4e46409a1c09b1d19d3859"
    ],
    "containsOwner": [
      "http://www.inmindcloud.com/security/security-implementation.owl#admin-Person"
    ]
  }
]
Array of object
object
id
string (base64-encoded URI)
ExampleaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BY2NvdW50I2UxNGYxMjQ0ZTJlNzRiM2E5YzM4OTY3MDZiYjFlNWRi
uri
string
Examplehttp://localhost:8080/iss/Account#e14f1244e2e74b3a9c3896706bb1e5db
type
string
ExampleAccount
objectId
string
Examplee14f1244e2e74b3a9c3896706bb1e5db
objectName
string
ExampleAccount1
accountOpportunityVolume
integer
Example0
accountProspect
boolean
Exampletrue
accountQuoteCount
integer
Example0
accountQuoteVolume
integer
Example0
hasIndustry
object
id
string (base64-encoded URI)
ExampleaHR0cDovL3d3dy5pbm1pbmRjbG91ZC5kZXYuY29tL2FwcGxpY2F0aW9uL2FwcGxpY2F0aW9uLWltcGxlbWVudGF0aW9uLm93bCNJSG90ZWw
uri
string
Examplehttp://www.inmindcloud.dev.com/application/application-implementation.owl#IHotel
includesAddress
Array of string
string (uri)
ExampleThe URI of account's address
usesMainAddress
Array of string
string (uri)
ExampleThe URI of account's address
containsContact
Array of string
string (uri)
ExampleThe URI of account's contacts
containsOwner
Array of string
string (uri)
ExampleThe URI of account's owner
objectDateOfCreation
integer (timestamp)
Example1594608096026
objectDateOfUpdate
integer (timestamp)
Example1594613347878