Get an account by account ID and filter conditions

  • 1 minute(s) read
Prev Next
Get
/accounts/{id}/partnerFunctions

Get an account by account ID and filter conditions.

Security
HTTP
Type bearer

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

Path parameters
id
string (base64-encoded URI) Required
ExampleaHR0cDovL2VjY2lkZXMvODAwL0FjY291bnQjQ1U3MDI=
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 account details.

{
  "id": "aHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BY2NvdW50IzgyZjFkNzc1MTUzNDRjNWU4NDY2Y2QxYThhNWYxYTVi",
  "type": "",
  "uri": "http://localhost:8080/iss/Account#82f1d77515344c5e8466cd1a8a5f1a5b"
}
object
id
string (base64-encoded URI)
ExampleaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BY2NvdW50I2UxNGYxMjQ0ZTJlNzRiM2E5YzM4OTY3MDZiYjFlNWRi
uri
string
Examplehttp://localhost:8080/iss/Account#e14f1244e2e74b3a9c3896706bb1e5db
type
string
ExampleAccount