logo

User Account

This document describes the API for reading User Accounts.

List User Accounts

Returns a list of User Accounts.

Search parameters

Filter Description
active Flag to indicate if this is an active User Account on the vendor side. Defaults to true if the vendor does not support or provide this value.
created_at The date this User Account was created
email The email received from the connection
first_name The first name of the user received from the connection
has_user Flag to indicate if this User Account has a User. False indicates that it's an unlinked account
id The ID of the User Account
last_name The last name of the user received from the connection
third_party_id The identifier for this User Account on the vendor side
updated_at The date this User Account was last updated
vendor_name The name of the vendor that this User Account is from
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 1000 items per response). Specifies the number of results for a given page.

q
string

Search and filter the User Account data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/user_accounts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a User Account
Returns a single User Account by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/user_accounts/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to User Evidence